Commit 120554a
📖 [Docs]: Process-PSModule owns the documentation root (#452)
Process-PSModule documentation now lives at the root of the site. Its
lifecycle overview, getting-started material, guides, reference,
specifications, and media no longer sit beneath a
`Modules/Process-PSModule` source hierarchy.
## Changed: The framework owns the root page
The root page now uses the Process-PSModule title, description, and
lifecycle content as its primary documentation. It retains the
non-duplicated PSModule and cross-organization context from the former
root page, so readers land directly in the framework without losing the
broader context.
## Changed: Clear top-level documentation sections
The navigation now presents Process-PSModule, Getting started, Guides,
Reference, Specification, and Modules at the top level. Reference
combines the framework's operational contracts with its
module-development standards. Modules is the standalone index for
discovering the PSModule organization’s modules. Dictionary pages remain
published for inline glossary links without occupying a visible
navigation tab.
## Fixed: The module index generator follows the new structure
The scheduled documentation update now fills the Modules page and
publishes each generated module detail page below it. Catalog icons and
module links resolve from their new root-level locations, so the next
automated refresh updates the visible module index instead of the
retired Catalog path.
---
<details>
<summary>Technical details</summary>
- Implementation plan progress: all steps in the scoped Task are
complete.
- Moved `get-started/`, `guides/`, `reference/`, `specification/`, and
`media/` with `git mv`, preserving file history.
- Merged the former inner landing page into `docs/content/index.md`; its
front matter, title, and framework content take precedence, while the
non-duplicated root content remains below it.
- Moved the module-development standards into `docs/content/reference/`
and added them to the top-level Reference navigation.
- Replaced the Catalog navigation entry with Modules, whose top-level
page is the module index.
- `Update-ModuleList` now writes generated pages to
`docs/content/Modules/Repositories/` and replaces the marker in
`docs/content/Modules/index.md`; the V2 catalog template references
assets at the correct depth.
- Added an isolated Pester regression test for the catalog generator and
installed its declared GitHub module dependency in the action test
workflow.
- Dictionary remains in Zensical's navigation graph because unlisted
pages are not built; a scoped stylesheet hides its tab and drawer
entries while preserving published glossary URLs.
- The strict clean Zensical build succeeds, the catalog Pester suite
passes, PSScriptAnalyzer reports no findings, and all in-repository
Markdown links resolve.
- Standards and framework alignment:
| Changed surface | Standards checked | Framework docs checked | Result
|
| --- | --- | --- | --- |
| `docs/content/**` | Documentation Model | Process-PSModule information
architecture | Aligned |
| `docs/zensical.toml` | Documentation navigation | Zensical navigation
indexes | Aligned |
| `.github/actions/update-index/**` | PowerShell testing and action
conventions | Generated module catalog contract | Aligned |
| `AGENTS.md` | Agentic Development | Canonical framework guidance |
Aligned |
- Issue convergence sweep: reviewed the parent PBI and its current
delivery leaves; this pull request implements only the scoped
documentation-navigation Task.
</details>
<details>
<summary>Relevant issues (or links)</summary>
- Fixes #451
- #423
</details>
---------
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>1 parent aa89bbe commit 120554a
40 files changed
Lines changed: 255 additions & 227 deletions
File tree
- .github
- actions/update-index
- src
- templates/module-catalog
- tests
- workflows
- docs
- content
- Modules
- Catalog
- Process-PSModule
- get-started
- guides
- media
- reference
- specification
- overrides/assets/stylesheets
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
831 | 831 | | |
832 | 832 | | |
833 | 833 | | |
834 | | - | |
| 834 | + | |
835 | 835 | | |
836 | 836 | | |
837 | 837 | | |
| |||
921 | 921 | | |
922 | 922 | | |
923 | 923 | | |
924 | | - | |
| 924 | + | |
925 | 925 | | |
926 | 926 | | |
927 | 927 | | |
| |||
Lines changed: 5 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
7 | | - | |
8 | | - | |
9 | | - | |
10 | | - | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
11 | 11 | | |
12 | 12 | | |
Lines changed: 59 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
| 39 | + | |
39 | 40 | | |
40 | 41 | | |
41 | 42 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
| 31 | + | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
34 | 34 | | |
35 | | - | |
| 35 | + | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | | - | |
8 | | - | |
9 | | - | |
| 7 | + | |
10 | 8 | | |
11 | | - | |
| 9 | + | |
12 | 10 | | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
37 | | - | |
| 37 | + | |
Lines changed: 5 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
| 22 | + | |
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | | - | |
| 28 | + | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
63 | | - | |
| 63 | + | |
64 | 64 | | |
65 | | - | |
| 65 | + | |
0 commit comments