-
Notifications
You must be signed in to change notification settings - Fork 91
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Context
Once the docs publishing pipeline (#617) is in place and PRs #601 (static docs) and #611 (API docs tooling) have merged, we need a final verification pass before the next release.
Why
- There will be a time gap between when the static docs were written and the release — code will have evolved.
- Validation warnings from the pipeline will have been soft-fail during initial rollout and need to be resolved.
- API docs coverage and docstring quality issues flagged by
audit_coverage.pyneed to be addressed.
Tasks
- Run
docs-publishworkflow withstrict_validation=trueand resolve all failures - Review static docs (
docs/docs/) against current code — update any outdated content, examples, or references - Ensure API coverage meets threshold (≥ 80%) with no regressions
- Address all docstring quality warnings (
uv run poe apidocs-quality) - Verify Mintlify renders correctly from
docs/stagingbranch - Flip
strict_validationdefault totrueindocs-publish.ymlif all checks pass - Final smoke test: run
workflow_dispatchtargetingdocs/productionequivalent
Timing
This should be completed before tagging the next release, as the release triggers the production docs publish.
Related
- docs: implement publishing pipeline #617 — publishing pipeline implementation
- docs: complete developer documentation rewrite (#480) #601 — static docs rewrite
- docs: Docs/api pipeline improvements #611 — API docs pipeline improvements
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation