Repository navigation
fix(docs): add mkdocs.yml at repo root and minimal page stubs - #6
Merged
Merged
Conversation
The docs-publish workflow expected mkdocs.yml at the repo root; the file was previously absent (Phase 1 spec placed it at docs/mkdocs.yml which is non-standard). This commit: - Adds mkdocs.yml at the repo root with mkdocs-material theme, full nav, and all required markdown extensions - Creates stub pages for the 6 nav entries that had no content file: docs/architecture/overview.md docs/architecture/uns_context_broker.md docs/standards/standards_alignment.md docs/governance/ai_rmf_profile.md docs/case_studies/smm_starter.md docs/case_studies/chips_supplier.md - Leaves docs/index.md and docs/governance/cmmc_l2_mapping.md untouched (they already have substantive content) - Adds [project.optional-dependencies] docs = [mkdocs-material, pymdown-extensions] to pyproject.toml Verified: mkdocs build --strict completes with 0 warnings. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Phase
Phase 9 follow-up: MkDocs site config
Summary
Resolves the post-merge
Build MkDocs Sitefailure onmain(commit9a740da). The docs-publish workflow was added in Phase 1 but themkdocs.ymlconfig it depends on was never created — Phase 1 spec §3.2listed it under
docs/, but the standard MkDocs convention (and what theworkflow expects) is at the repo root.
What changed
mkdocs.ymlat repo root — Material theme, full nav, pymdownx extensionsdocs/architecture/overview.md— 10-agent pipeline diagram, designprinciples, agent roles table
docs/architecture/uns_context_broker.md— zone enforcement, topicformat reference, API example
docs/standards/standards_alignment.md— full standards matrix(ISA-95, MQTT Sparkplug B, OPC UA, NIST SP 800-82, CMMC L2, NIST AI RMF,
ISO 42001, ISO 14224)
docs/governance/ai_rmf_profile.md— GOVERN/MAP/MEASURE/MANAGEfunction mapping with code examples
docs/case_studies/smm_starter.md— 5-minute local Ollama quickstartfor SMMs (NIST MEP-audience targeted)
docs/case_studies/chips_supplier.md— Bedrock/GovCloud deploymentfor CHIPS Act Tier-2/Tier-3 suppliers
pyproject.toml— added[docs]extras group withmkdocs-material>=9.5and
pymdown-extensions>=10.0docs/index.mdanddocs/governance/cmmc_l2_mapping.mdleft untouched(already existed with substantive content)
Acceptance criteria covered
mkdocs build --strictpasses with zero warningsdocs_dir: docs)How to verify
Why this matters for the project
GitHub Pages will auto-deploy on merge, producing a citable docs URL at
https://adris-misra.github.io/multi-agentic-framework/ — the docs site
itself becomes a public, dated, citable artifact.
Out of scope
docs/index.mdandcmmc_l2_mapping.mdbeyond what's already there