Tighten docs cross-references#61
Merged
Merged
Conversation
why: Docs guidance requires first-mention links, valid console examples, and concept-first reader framing across the rendered site. what: - Link rendered docs objects and page references with MyST/Sphinx roles - Refresh quickstart, contributor, code-style, release, and API prose - Add the root just build-docs entrypoint used by the required gate
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #61 +/- ##
=======================================
Coverage 96.89% 96.89%
=======================================
Files 5 5
Lines 129 129
=======================================
Hits 125 125
Misses 4 4 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
why: The docs cleanup should appear in the release notes as a reader-facing improvement, not just as implementation detail in the PR. what: - Add a high-level Documentation entry for clearer docs paths - Describe the reader outcome without listing internal link mechanics
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
2 participants
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
just build-docsentrypoint and update docs intersphinx URLs.Tests
rm -rf docs/_build; uv run ruff check . --fix --show-fixes; uv run ruff format .; uv run mypy .; uv run py.test --reruns 0 -vvv; just build-docs;