Skip to content

馃摉 [Docs]: Documentation site now builds with Zensical - #71

Closed
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
zensical-migration
Closed

馃摉 [Docs]: Documentation site now builds with Zensical#71
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
zensical-migration

Conversation

@MariusStorhaug

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

Copy link
Copy Markdown
Member

Fonts documentation now builds with Zensical while keeping the module overview and generated command reference available.

Changed: Documentation site uses Zensical

The published site uses the current Process-PSModule design, automatic navigation, fonts, palette controls, search, code tools, social links, and consent metadata. Command pages are generated from Get-Font, Install-Font, and Uninstall-Font during CI and discovered by Zensical without a hard-coded function list.

The contributor link now leads to the repository's active issue list instead of a missing file.


Technical details
  • Replaced .github/mkdocs.yml with the Zensical configuration selected by Process-PSModule v8.
  • Set docs_dir = "docs" because v8 stages README, icon, and generated help under outputs/site/docs; it does not copy a repository docs/content tree into the site workspace.
  • Aligned theme features and extensions with Process-PSModule commit 59e056cab018777a8f158f88fcabdb57125494ef and pinned its shared override assets through jsDelivr because v8 does not stage consumer override directories.
  • Left navigation discovery to Zensical so generated command additions and removals require no configuration changes.
  • Disabled repository edit/view actions because generated command pages have no corresponding source files in the repository.
  • Verified TOML parsing, automatic generated-page discovery, external links and assets, Markdown linting, and a strict clean Zensical build from docs against the v8 staging layout.
  • Implementation plan progress: documentation migration, validation, and delivery are complete in this pull request.
  • Issue convergence sweep: no additional open issue is fully satisfied by this focused documentation change.
Changed surface Standards checked Framework docs checked Result
.github/zensical.toml MSX documentation and PR standards Process-PSModule v8 site assembly and current Zensical baseline Aligned
README.md MSX natural language and Markdown Process-PSModule README publishing behavior Fixed in this PR
Relevant issues (or links)

Related work

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the documentation site configuration to build with Zensical (via Process-PSModule v8) while keeping the module overview and generated command reference available, and fixes the README contributor guidance to point to the repo issues list.

Changes:

  • Replace MkDocs configuration (.github/mkdocs.yml) with a new Zensical configuration (.github/zensical.toml) aligned with Process-PSModule v8.
  • Configure Zensical navigation to include the README landing page plus generated command reference pages.
  • Update README contribution text to link to the repository issues list instead of a missing CONTRIBUTING file.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
README.md Updates contributor guidance to link to the repo鈥檚 issues list.
.github/zensical.toml Adds Zensical site configuration (theme, nav, plugins, extensions, consent/social).
.github/mkdocs.yml Removes obsolete MkDocs configuration in favor of Zensical.

馃挕 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/zensical.toml

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

@MariusStorhaug

Copy link
Copy Markdown
Member Author

Superseded by #70, which now contains this validated Zensical migration together with the required coverage and forced-install fixes. The combined branch is green across Build-Site, coverage, all platform tests, lint, and CodeQL.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release:none No release impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants