Repository navigation
docs: fix doc references that never resolved, and gate cargo doc in CI - #3834
Merged
Merged
Conversation
aeppling
requested changes
Sep 11, 2026
KuSh
force-pushed
the
docs/fix-relative-links
branch
2 times, most recently
from
September 17, 2026 22:40
77dd0ea to
8773840
Compare
3 tasks done
KuSh
force-pushed
the
docs/fix-relative-links
branch
from
September 28, 2026 01:03
8773840 to
717e1e9
Compare
KuSh
force-pushed
the
docs/fix-relative-links
branch
from
October 7, 2026 07:38
717e1e9 to
a667110
Compare
Fixes 42 broken relative links and anchors in the markdown docs and the 20 doc comments that make `cargo doc` fail under `warnings = "deny"`, and adds a `rustdoc` CI job so the second class cannot come back unnoticed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
KuSh
force-pushed
the
docs/fix-relative-links
branch
from
October 8, 2026 17:34
a667110 to
f850592
Compare
Merged
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.
What
Fixes documentation references that never resolved, and adds the CI gate that keeps the rustdoc half from coming back.
Markdown. 42 relative links and anchors on
developpoint nowhere.docs/TROUBLESHOOTING.mdmoved todocs/guide/resources/troubleshooting.mdand six files still use the old path.docs/contributing/TECHNICAL.mdaddresses the repo root as../, which lands indocs/, so its 29 links tosrc/andhooks/READMEs have never worked.SECURITY.mdnames a workflow whose jobs now live inci.yml, the twodocs/usage/pages point at files one level too high, andCONTRIBUTING.mdlinksTECHNICAL.md#testingwhere the heading is## 8. Testing..github/PULL_REQUEST_TEMPLATE.mdkeeps its../blob/master/CONTRIBUTING.mdform on purpose. GitHub renders that file into the PR body, so the link resolves against the PR URL: that form reaches the file and../CONTRIBUTING.mdreturns 404. A comment above the link says so, because the form reads like a mistake.rustdoc.
cargo docfails ondevelop:warnings = "deny"makes rustdoc lints fatal, and 20 doc comments trip one. Most are literal output tokens rustdoc reads as markup, such as sbt's[info]lines,argv[0]and<ref>; three are bare URLs. Two inuser_env.rslink to#[cfg(test)]helpers rustdoc cannot see, and one intracking.rsnames atrackfunction that no longer exists.src/main.rssilences the lint with anallowinstead of backticks, because that doc comment is clap's help text and backticks would show up inrtk git --help.CI. Nothing runs
cargo doctoday; thedoc reviewjob is the AI reviewer. Arustdocjob now runs besidefmtandclippy.Rules. Rule 6 of
.claude/rules/rust-patterns.mdsends contributors totokenize_with_options, which does not exist; it now namestokenize_grammar.No change to command output or behaviour.
Test plan
cargo doc --no-deps: 20 errors ondevelope0b2e85, 0 on this branch..mdfiles: 49 findings ondevelop, 7 here. The 7 are the PR-template link above, five../../issues-style links inCONTRIBUTING.mdthat resolve in GitHub's URL space (each fetched: 200), and a placeholder in a skill's prose.cargo fmt --all --check,cargo clippy --all-targetswith 0 warnings,cargo test --all4261 passed, 0 failed.rtk git --helpprints the-Cline unchanged.🤖 Generated with Claude Code