Skip to content

📖 [Docs]: Process-PSModule owns the documentation root - #452

Merged
Marius Storhaug (MariusStorhaug) merged 8 commits into
mainfrom
restructure-process-docs
Aug 9, 2026
Merged

📖 [Docs]: Process-PSModule owns the documentation root#452
Marius Storhaug (MariusStorhaug) merged 8 commits into
mainfrom
restructure-process-docs

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Aug 9, 2026

Copy link
Copy Markdown
Member

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.


Technical details
  • 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.
Relevant issues (or links)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actions Bot commented Aug 9, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
CSS Pass ✅
CSS_PRETTIER Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
HTML Pass ✅
JAVASCRIPT_ES Pass ✅
JAVASCRIPT_PRETTIER Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title 📖 [Docs]: Framework leads Process-PSModule documentation 📖 [Docs]: Process-PSModule owns the documentation root Aug 9, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review August 9, 2026 09:09
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@MariusStorhaug
Marius Storhaug (MariusStorhaug) merged commit 120554a into main Aug 9, 2026
79 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the restructure-process-docs branch August 9, 2026 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make Process-PSModule the documentation entry point

1 participant