Skip to content

docs: pre-release documentation verification pass #645

@planetf1

Description

@planetf1

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.py need to be addressed.

Tasks

  • Run docs-publish workflow with strict_validation=true and 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/staging branch
  • Flip strict_validation default to true in docs-publish.yml if all checks pass
  • Final smoke test: run workflow_dispatch targeting docs/production equivalent

Timing

This should be completed before tagging the next release, as the release triggers the production docs publish.

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions