Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/docs/Frameworks/Process-PSModule/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Process-PSModule
description: The end-to-end GitHub Actions workflow that builds, tests, versions, and publishes every PSModule PowerShell module — configured through a single settings file.
description: The end-to-end GitHub Actions workflow that builds, tests, versions, and publishes every PSModule PowerShell module and documentation site — configured through a single settings file and zensical.toml for site generation.
---

# Process-PSModule
Expand All @@ -27,7 +27,8 @@ projects.
secret on the organization.
3. Clone the repo locally, create a branch, make your changes, push the changes, create a PR and let the workflow run.
- Adding a `Prerelease` label to the PR will create a prerelease version of the module.
4. When merging to `main`, the workflow automatically builds, tests, and publishes your module to the PowerShell Gallery and maintains the
4. Use `.github/zensical.toml` for site generation. Process-PSModule builds documentation with Zensical from this file.
5. When merging to `main`, the workflow automatically builds, tests, and publishes your module to the PowerShell Gallery and maintains the
documentation on GitHub Pages. By default the process releases a patch version, which you can change by applying labels like `minor` or `major` on
the PR to bump the version accordingly.

Expand Down
3 changes: 2 additions & 1 deletion src/docs/Frameworks/Process-PSModule/pipeline-stages.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,8 @@ The [PSModule - Module tests](https://github.com/PSModule/Process-PSModule/blob/
[workflow](https://github.com/PSModule/Process-PSModule/blob/main/.github/workflows/Build-Site.yml)

- Generates a static site using:
- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
- [Zensical](https://zensical.org/).
- Uses `zensical.toml` as the site configuration contract.

## Publish Docs

Expand Down
3 changes: 2 additions & 1 deletion src/docs/Frameworks/Process-PSModule/repository-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Process-PSModule expects repositories to follow the staged layout produced by Te
│ │ └── Process-PSModule.yml # Consumer hook into this workflow bundle
│ ├── CODEOWNERS # Default reviewers enforced by Process-PSModule checks
│ ├── dependabot.yml # Dependency update cadence handled by GitHub
│ ├── mkdocs.yml # MkDocs config consumed during site builds
│ ├── zensical.toml # Site config consumed during site builds
│ ├── PSModule.yml # Settings parsed to drive matrices
│ └── release.yml # Release automation template invoked on publish
├── examples/ # Samples referenced in generated documentation
Expand All @@ -39,6 +39,7 @@ Process-PSModule expects repositories to follow the staged layout produced by Te
Key expectations:

- Keep at least one exported function under `src/functions/public/` and corresponding tests in `tests/`.
- Keep documentation site configuration in `.github/zensical.toml`.
- Optional folders (`assemblies`, `formats`, `types`, `variables`, and others) are processed automatically when present.
- Markdown files in `src/functions/public` subfolders become documentation pages alongside generated help.
- A group's overview page (`<Category>/<Category>.md` named after the folder, or `<Category>/index.md`) becomes that group's section landing page in the docs navigation.
Expand Down
1 change: 1 addition & 0 deletions src/docs/Frameworks/Process-PSModule/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: How to call the Process-PSModule workflow — inputs, secrets, perm
# Usage

To use the workflow, create a new file in the `.github/workflows` directory of the module repository and add the following content.
For documentation site generation, use `zensical.toml` as the active site contract.

<details>
<summary>Workflow suggestion</summary>
Expand Down
2 changes: 1 addition & 1 deletion src/docs/Frameworks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ cover how it works, how to use it, and how to configure it.
| Section | Description |
| --- | --- |
| [Agentic Development](Agentic-Development/index.md) | The framework for org-scoped docs and memory repositories that give agents project-specific standards, working knowledge, and behavior. |
| [Process-PSModule](Process-PSModule/index.md) | The end-to-end GitHub Actions workflow that builds, tests, versions, and publishes every PSModule PowerShell module — configured through a single settings file. |
| [Process-PSModule](Process-PSModule/index.md) | The end-to-end GitHub Actions workflow that builds, tests, versions, and publishes every PSModule PowerShell module and documentation site — configured through a single settings file and zensical.toml for site generation. |

<!-- INDEX:END -->

Expand Down