Repository navigation
Name broken-link docs by repo-relative path, not basename - #169
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (scored against CI run 40634734724 on the PR head and the diff):
Judgment call: Merge status: This comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
3 of 4 tasks
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_local_links()inscripts/check_docs.pynow names the offending doc by its path relative to the repo root (doc.relative_to(REPO_ROOT).as_posix()) instead of its basename (doc.name). Before this change, a broken link inscripts/README.mdwas reported asREADME.md: broken relative link -> …, which points at the root README instead. Root-level docs get the same message as before.test_link_resolves_relative_to_containing_docpreviously asserted the basename-only message (SAME.md:for a file atdocs/SAME.md). It now assertsdocs/SAME.md:.test_same_named_docs_are_told_apart_by_path: a rootREADME.mdand ascripts/README.mdwith a broken link. The error must namescripts/README.md.Closes #168
Skipped issues: every other open issue was left alone this cycle. Each one is either a template-behavior change, which can't be validated in a headless dispatch and so could not merge autonomously (#109), or the
CLAUDE.mdedit in #106, which needs separate authorization. A Stage A documentation sweep was done first: README, CONTRIBUTING, SECURITY, the PR/issue templates andscripts/README.mdwere checked againstcreate-dev-loop.md, and every RESEARCH.md ship date was checked against GitHub'smergedAt. No drift was found. This bug turned up as an "unhelpful error message" during the same sweep.Research grounding
No RESEARCH.md finding applies. The change only affects the wording of a CI error message and doesn't touch the template or any phase definition.
Doc sync check
No doc needed changes. No document quotes the old message format (checked by grepping for
broken relative link), andCLAUDE.md/CONTRIBUTING.mddescribe the check as "relative links between the repo's own docs resolve", which is still accurate.Test plan
python3 scripts/check_docs.py→ "Doc consistency check passed."python3 -m unittest discover -s tests→Ran 42 tests … OKscripts/check_docs.pychecked out fromorigin/main, two tests fail (test_link_resolves_relative_to_containing_doc,test_same_named_docs_are_told_apart_by_path). With the fix restored, all 42 pass./create-dev-loopbehavioral run is needed: the template is unchanged.Merge note:
scripts/check_docs.pyis on this repo's dev-loop do-not-auto-merge list (it is the only mechanical doc gate), so this PR is left open for maintainer review rather than merged autonomously.This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
🤖 Generated with Claude Code
drafted by Claude on behalf of Daniel Stephenson