Repository navigation
Conversation
README.md, tasks/README.md and docs/*.md link to each other, to assets and to workflow files by relative path and heading anchor. A rename broke nothing that CI would notice. The new test resolves every relative link and image source, and checks that each #anchor names a heading in the target document.
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.
README.md,tasks/README.mdanddocs/*.mdlink to each other, to assets and to workflow files by relative path and heading anchor.tests/test_doc_links.pyresolves every relative link and image source and checks that each#anchormatches a heading in the target document, using GitHub's slug rules.All links on
mainresolve. Renaming a heading or a file referenced from the docs makes the test fail with the source file and the broken link.docs/development.mdmentions it.uv run python -m unittest discover -s testsuv run ruff check scripts src testsuv run ruff format --check scripts src tests