Skip to content

fix(docs): make MkDocs strict build use docs dir#376

Open
carloshvp wants to merge 1 commit into
agentrust-io:mainfrom
carloshvp:fix-mkdocs-docs-dir
Open

fix(docs): make MkDocs strict build use docs dir#376
carloshvp wants to merge 1 commit into
agentrust-io:mainfrom
carloshvp:fix-mkdocs-docs-dir

Conversation

@carloshvp

Copy link
Copy Markdown
Member

Summary

  • change mkdocs.yml to use docs_dir: docs instead of the repository root
  • update MkDocs nav, assets, llms.txt inputs, and edit links to be relative to docs/
  • simplify the docs deploy workflow so it builds the committed MkDocs config directly
  • fix the kill-switch tutorial link that depended on the old repo-root docs layout

Why

docs_dir: . causes current MkDocs strict builds to fail before page rendering because the docs directory is the parent of the config file. This removes the repo-root docs source workaround and makes a plain strict build valid.

mkdocs.yml was also normalized from CRLF to LF in this PR. That keeps git diff --check clean and avoids the sed/line-ending fragility that affected generated docs configs.

Fixes #364.

Validation

python -m mkdocs build --strict --site-dir /tmp/cmcp-site-check

Result: strict docs build passes locally.

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@carloshvp carloshvp marked this pull request as ready for review July 4, 2026 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(mkdocs): "docs_dir: ." breaks mkdocs build --strict

2 participants