Skip to content

Commit b23666b

Browse files
Describe the framework-first documentation hierarchy
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 73b21ca commit b23666b

4 files changed

Lines changed: 30 additions & 21 deletions

File tree

docs/content/Modules/Catalog/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This catalog tracks modules maintained in the PSModule organization and what each module does.
44

5+
The catalog is separate from the [Process-PSModule framework](../Process-PSModule/index.md). Use the framework documentation to build and release a module; use this page to discover the modules available to install and use.
6+
57
## Scope
68

79
Each module page should capture:

docs/content/Modules/Process-PSModule/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,19 @@ New to Process-PSModule? Work through these in order.
3232
| [Repository setup](get-started/repository-setup.md) | Configure GitHub Pages, the PowerShell Gallery API key, permissions, and the caller workflow. |
3333
| [Your first release](get-started/your-first-release.md) | The pull request flow, version labels, and what happens on merge. |
3434

35+
## Module development foundations
36+
37+
The framework automates a module's lifecycle; these conventions define the module it builds and releases.
38+
39+
| Page | Description |
40+
| --- | --- |
41+
| [Module development foundations](../index.md) | The full set of module-authoring conventions supported by the framework. |
42+
| [Repository Standard](../Repository-Standard.md) | Required repository files, metadata, onboarding, and workflow wiring. |
43+
| [PowerShell module standard](../Standards.md) | Source layout, function design, and module-specific implementation conventions. |
44+
| [Module types](../Module-Types.md) | Conventions for integration (API) and data modules. |
45+
| [Test Specification](../Test-Specification.md) | Consistent Pester test structure and coverage expectations. |
46+
| [Versioning](../Versioning.md) | Semantic version changes based on public API impact. |
47+
3548
## Guides
3649

3750
Task-oriented deep dives into the pipeline's functionality.

docs/content/Modules/index.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,13 @@
1-
# Modules
1+
# Module development foundations
22

3-
Process-PSModule now hosts PSModule-org module documentation.
3+
Process-PSModule is the framework for building, testing, versioning, documenting, and publishing PowerShell modules. These foundations define the repository, source, test, and release conventions that the framework supports and validates.
44

5-
This section is the local source of truth for:
5+
Start with the [Process-PSModule overview](Process-PSModule/index.md) to understand the workflow. Use these pages when creating or maintaining a module that runs through it.
66

7-
- module catalog and module-level specs
8-
- Process-PSModule structure and build flow
9-
- repository anatomy and template onboarding
10-
11-
## Sections
12-
13-
- [Repository Standard](Repository-Standard.md)
14-
- [Standards](Standards.md)
15-
- [Module types](Module-Types.md)
16-
- [Test Specification](Test-Specification.md)
17-
- [Versioning](Versioning.md)
18-
- [Catalog](Catalog/index.md) (auto-generated from PSModule repo metadata, release data, and README summaries)
19-
- [Process-PSModule](Process-PSModule/index.md)
7+
| Page | Use it for |
8+
| --- | --- |
9+
| [Repository Standard](Repository-Standard.md) | Creating a module repository with the required metadata, files, and framework wiring. |
10+
| [PowerShell module standard](Standards.md) | Structuring source code, designing functions, and applying module-specific conventions. |
11+
| [Module types](Module-Types.md) | Applying conventions for integration (API) and data modules. |
12+
| [Test Specification](Test-Specification.md) | Writing consistent, comprehensive Pester tests for module functions. |
13+
| [Versioning](Versioning.md) | Choosing semantic version changes from the module's public API impact. |

docs/content/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ We empower PowerShell-savvy developers to effortlessly transform their ideas int
3333

3434
Where we are headed is tracked as [objectives and initiatives](https://msxorg.github.io/docs/Ways-of-Working/Goal-Setting/).
3535

36-
## PSModule documentation
36+
## Process-PSModule framework
3737

38-
This site covers PSModule organization-specific documentation:
38+
This site is the documentation home for the Process-PSModule framework: the reusable workflow that builds, tests, versions, documents, and publishes PowerShell modules.
3939

40-
- [Modules](Modules/index.md): module catalog and module-specific standards
41-
- [Process-PSModule](Modules/Process-PSModule/index.md): how modules are structured and built
42-
- [Template onboarding](Modules/Process-PSModule/get-started/index.md): how to start from the template
40+
- [Process-PSModule](Modules/Process-PSModule/index.md): start with the workflow, then follow its getting-started path, guides, reference, and specification.
41+
- [Module development foundations](Modules/index.md): the repository, source, module-type, test, and versioning conventions that the framework supports.
42+
- [Catalog](Modules/Catalog/index.md): discover modules maintained in the PSModule organization.
4343

4444
## Cross-org guidance
4545

0 commit comments

Comments
 (0)