diff --git a/src/docs/Frameworks/Process-PSModule/index.md b/src/docs/Frameworks/Process-PSModule/index.md index ad97cfd..f1512a4 100644 --- a/src/docs/Frameworks/Process-PSModule/index.md +++ b/src/docs/Frameworks/Process-PSModule/index.md @@ -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 @@ -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. diff --git a/src/docs/Frameworks/Process-PSModule/pipeline-stages.md b/src/docs/Frameworks/Process-PSModule/pipeline-stages.md index a786755..349f01e 100644 --- a/src/docs/Frameworks/Process-PSModule/pipeline-stages.md +++ b/src/docs/Frameworks/Process-PSModule/pipeline-stages.md @@ -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 diff --git a/src/docs/Frameworks/Process-PSModule/repository-structure.md b/src/docs/Frameworks/Process-PSModule/repository-structure.md index 399c1fd..870599f 100644 --- a/src/docs/Frameworks/Process-PSModule/repository-structure.md +++ b/src/docs/Frameworks/Process-PSModule/repository-structure.md @@ -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 @@ -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 (`/.md` named after the folder, or `/index.md`) becomes that group's section landing page in the docs navigation. diff --git a/src/docs/Frameworks/Process-PSModule/usage.md b/src/docs/Frameworks/Process-PSModule/usage.md index eeb045a..5b74fef 100644 --- a/src/docs/Frameworks/Process-PSModule/usage.md +++ b/src/docs/Frameworks/Process-PSModule/usage.md @@ -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.
Workflow suggestion diff --git a/src/docs/Frameworks/index.md b/src/docs/Frameworks/index.md index 343474c..a3d1e56 100644 --- a/src/docs/Frameworks/index.md +++ b/src/docs/Frameworks/index.md @@ -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. |