docs: add public release documentation QA checklist - #440
Open
yaoyao12345666 wants to merge 1 commit into
Open
Conversation
yaoyao12345666
force-pushed
the
docs/public-release-qa-checklist
branch
from
August 1, 2026 11:38
7c6a599 to
d43bd3e
Compare
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.
What does this PR do?
Adds a discoverable public-release documentation QA checklist covering:
This is documentation-only and does not change runtime behavior.
Related issue
Fixes #146
Type of change
How was it tested?
python -m sphinx -E -a -W --keep-going -b html docs .docs-build-146-finalpython -m sphinx -E -a -W --keep-going -b linkcheck docs .docs-linkcheck-146-finalruff check docs --no-cacheareno train --help,areno serve --help,areno check --help, andareno env --helpBoth strict Sphinx builds completed without warnings or broken links.
Checklist
pytest tests/ -k cpu) - not rerun for this documentation-only change on Windows.