Implement documentation quality commands - #6
Merged
Conversation
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.
Summary
check-docs-format,check-docs-links, andbuild-docsconsole commandsWhy
The documentation-only profile declared three quality commands that the package did not provide. That made the example aspirational rather than executable. This change turns those names into a supported command surface and makes the reference repository demonstrate the same contract.
Impact
The package now includes Python Markdown, mdformat, and MkDocs as direct runtime dependencies.
check-docs-linksperforms outbound HTTP(S) requests by default;--no-externaldisables them, and--exclude-url-prefixrecords intentional exceptions.build-docsreplaces the configured MkDocs output directory.Validation
uv sync --locked --all-groupsuv run pre-commit run --all-filesuv run ruff format --check .uv run ruff check .uv run ty checkuv run pytest(30 passed)uv run repo-quality check .uv run check-docs-formatuv run check-docs-linksuv run build-docsuv build