mkdocs to zensical github pages

[shivashanmugam]

Local verification of zensical-docs-integration
.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.51%. Comparing base (f296252) to head (418aa27).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #126   +/-   ##
=======================================
  Coverage   96.51%   96.51%           
=======================================
  Files          28       28           
  Lines        1264     1264           
=======================================
  Hits         1220     1220           
  Misses         44       44           

Flag	Coverage Δ
integration	58.86% <ø> (-0.32%)	⬇️
ollama_local	54.74% <ø> (ø)
slow-browser	44.85% <ø> (ø)
slow-other	66.53% <ø> (+1.42%)	⬆️
unit	85.60% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[shivashanmugam]

@microsoft-github-policy-service agree company="Microsoft"

[shivashanmugam]

@microsoft-github-policy-service agree company="Microsoft"

[Copilot]

Pull request overview

Updates the documentation site deployment pipeline to use the Zensical tool/theme instead of MkDocs Material for GitHub Pages publishing.

Changes:

• Switch MkDocs theme from material to zensical in mkdocs.yml.
• Update the GitHub Pages workflow to install zensical and run zensical build --clean instead of mkdocs build --strict.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
mkdocs.yml	Changes the configured theme name to zensical for the docs site.
.github/workflows/pages.yml	Changes the Pages build steps to install and build with zensical.

Comments suppressed due to low confidence (1)

mkdocs.yml:12

• After switching the theme name to zensical, the rest of the theme: configuration still contains MkDocs Material–specific settings (e.g., features: navigation.instant, and toggle.icon: material/brightness-*). If Zensical doesn’t support these keys/icons, the docs build will fail at config validation or render incorrectly. Update the theme configuration to the Zensical-compatible options, or confirm Zensical is a Material-compatible theme and keep only supported keys.

  name: zensical
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The workflow now installs only zensical, but mkdocs.yml enables pymdownx.* markdown extensions. Unless zensical pulls those dependencies in transitively, the site build will fail due to missing Python modules. Consider installing the docs toolchain explicitly (e.g., the required markdown extension packages and any generator runtime) or using a dedicated requirements file for docs.

Suggested change

	- name: Install Zensical
	run: pip install zensical
	- name: Install docs toolchain
	run: pip install zensical pymdown-extensions

[Copilot]

Installing zensical without a version pin makes the Pages build non-reproducible and increases supply-chain risk (a newly released version could break the build). Pin the package version (or install from a locked requirements/constraints file) so GitHub Pages deployments are deterministic.

Suggested change

	run: pip install zensical
	run: pip install zensical==1.0.0