Project management operations¶
These are things maintainers should watch for during a release.
Documentation branch¶
The published docs site is built and deployed only from the framework-dev branch (see .github/workflows/docs.yml). mkdocs.yml's edit_uri: edit/framework-dev/docs/ records that branch, and scripts/generate_md_index.py parses it from there to build GitHub links for files outside docs/ (README, CONTRIBUTING, plugins/, src/, etc.) in Markdown_Index.md.
Any other doc that needs to link to a file outside docs/ should use the same {{ github_blob_url }} macro variable (defined in scripts/mkdocs_macros.py) rather than a relative path — relative ../ links to files outside docs_dir are not part of the mkdocs build and will 404 on the published site. Since macro rendering is opt-in (render_by_default: false in mkdocs.yml), add render_macros: true to the page's front matter to use it.
If the branch that carries the docs changes (e.g. at a release), update it in one place — edit_uri in mkdocs.yml — then regenerate the index: