docs: fix two broken cross-references (#19296)#19300
Open
ChrisJr404 wants to merge 1 commit intoastral-sh:mainfrom
Open
docs: fix two broken cross-references (#19296)#19300ChrisJr404 wants to merge 1 commit intoastral-sh:mainfrom
ChrisJr404 wants to merge 1 commit intoastral-sh:mainfrom
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
The
CommandsandSettingsbullets indocs/reference/index.mduse relative links (./cli.mdand./settings.md), but those files were removed from the repo in #16969 (they're now generated only at publish time). The links 404 when viewed on GitHub, andmkdocs build --strictemits two warnings forreference/index.mdagainst a clean checkout.This swaps the two links to absolute URLs, matching the pattern already used elsewhere in the docs (e.g.,
docs/concepts/cache.md,docs/concepts/projects/init.md).Before / after
The other three bullets in the same list (
./internals/resolver.md,./storage.md,./policies/index.md) target files that exist in the repo and continue to work both on GitHub and on the rendered site, so they are left as-is.Test plan
uv run --only-group docs mkdocs build --strict -f mkdocs.yml: the twoDoc file 'reference/index.md' contains a link './cli.md' / './settings.md'warnings are gone after this change.Closes #19296.