Repository navigation
chore: add the MkDocs build for the user guide - #10715
Merged
Merged
Conversation
paulbalandan
force-pushed
the
docs-md-2-build
branch
from
November 3, 2026 11:00
e5f17fb to
2dfad6c
Compare
michalsn
approved these changes
Nov 3, 2026
paulbalandan
force-pushed
the
docs-md-2-build
branch
from
November 3, 2026 13:19
2dfad6c to
32da80a
Compare
This was referenced Nov 3, 2026
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.
Description
Part 2 of the user guide migration agreed in #10683. It builds on #10714, so it needs that PR merged first. The Sphinx build and the deployment are unchanged, and nothing publishes the Markdown yet.
What this adds
mkdocs.ymland the Material theme indocs/overrides/, withdocs/requirements.txtfor the Python packages. The theme and the requirements file live indocs/so that onlymkdocs.ymlis added at the repository root.exclude_docskeeps them out of the built site.admin/llms.pywritesllms.txt,llms-full.txtand a Markdown copy of each page beside its HTML (item 8 of docs: decisions needed to migrate the user guide to MkDocs #10683). It reads only the nav and the Markdown, so it does not depend on MkDocs.admin/anchors.pyadds the anchor ids that the Sphinx guide used (RST labels and PHP object ids) to the built HTML, so that old links with a#fragmentstill scroll to their section. The ids are listed indocs/.anchors.json, which keeps the Markdown clean.admin/update-docs-nav.phpkeepsdocs/.nav.ymlup to date. It adds a page that is missing from the nav to the section whose first page links to it, in the order of that list.--checkchanges nothing and exits with 1 when a page is missing or a nav entry has no file. It has a test intests/system/AutoReview/UpdateDocsNavTest.php.markdown_checkjob intest-userguide.ymlthat runs the nav check, the strict MkDocs build,llms.pyandanchors.py. The job fails when a page is missing fromdocs/.nav.yml. Runningphp admin/update-docs-nav.phpfixes it..gitattributesexcludesdocs/andmkdocs.ymlfrom the Composer archive,.editorconfigkeeps the two trailing spaces that the converted pages use as line breaks, and.gitignorecoverssite/,venv/and__pycache__/.Checklist: