Docs website — MkDocs Material on GitHub Pages - #34
Merged
Conversation
- MkDocs Material site generated from the existing public docs (no duplicate documentation tree), with search, section nav, dark mode, copyable code, responsive industrial visual system, and a purpose-built product home page - GitHub Pages workflow builds docs on pull requests and deploys only from main; configure-pages enables Pages on the first successful main run - Public nav excludes internal sales/gate docs and scan artifacts; links to root-level SECURITY/CHANGELOG/demo script remain valid via GitHub URLs - Strict-build fixes for stale cross-repo links; README now points at the public site; generated site/ is ignored Validated: mkdocs build --strict, ruff, mypy, 537 tests.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Launches Meridian's first public docs website at https://imv-in.github.io/Meridian/, generated from the existing
docs/tree rather than introducing a second source of truth.What changed
mkdocs.yml: searchable section nav, dark mode, edit links, code copy, responsive Material theme.github/workflows/docs.yml: strict build on PRs; deploy onmainwith official Pages actions; first main run enables PagesREADME.mdpoints at the public site;site/ignored.[docs]optional extra pins MkDocs Material 9.xValidation
mkdocs build --strict— pass/Meridian/ruff check .— passmypy meridian— passpytest -q— 537 passedDeployment note
The repository does not currently have GitHub Pages enabled. The official
actions/configure-pages@v5step usesenablement: true; the first successfulmainworkflow run should enable workflow-based Pages automatically. If organization policy blocks automatic enablement, set Settings → Pages → Source: GitHub Actions once.