Repository navigation
docs: update contributor docs and tooling references - #10718
Merged
paulbalandan merged 2 commits intoNov 3, 2026
Merged
Conversation
michalsn
approved these changes
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 5 of the user guide cutover in #10683, after #10714, #10715, #10716 and the switch in #10717. This is the last PR of the series. It updates the contributor docs and the tooling that still refer to
user_guide_src/and Sphinx.Two commits:
contributing/documentation.rstand its TextMate bundle are replaced bycontributing/documentation.md. It covers the MkDocs setup (mkdocs serve,mkdocs build --strict), the navigation indocs/.nav.ymlwithadmin/update-docs-nav.php, headings, links, admonitions, code fences and the Python-Markdown whitespace rules.contributing/pull_request.mdlinks to the new guide, todocs/changelogsanddocs/installation, and to the changelog and upgrading pages under/develop/on GitHub Pages..github/instructions/user-guide.instructions.mdnow applies todocs/**/*.md.carson.ymllabelsdocs/**as documentation.docs/changelogs/v{VERSION}.md, and the worker-mode instructions point atdocs/installation/worker_mode.md.user_guide_srcentries are removed from the four.gitignorefiles, and the root one is tidied (grouped sections, stale paths and the Vagrant entries removed).README.md,tests/README.mdand two@seedocblock URLs inUpdateTest.phpuse the/develop/Pages path, since the Pages root only redirects the index.pipentry fordocs/requirements.txt, grouped into one PR.Notes
Checklist: