docs: unbreak rustdoc CI (escape angle-bracket placeholders)#503
docs: unbreak rustdoc CI (escape angle-bracket placeholders)#503EffortlessSteven wants to merge 1 commit into
Conversation
`<lane>`, `<path>` and `[options]` in doc comments were being parsed by rustdoc as HTML tags and intra-doc links, failing the strict `-D warnings` gate in `.github/workflows/docs.yml`. Wrap them in backticks / code blocks so they render verbatim.
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (3)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Compatibility Layer Usage ReportCurrent usage count: 193 📈 Usage Trend (Last 30 Days)
Usage Details
... and 183 more occurrences Migration GuideTo migrate these usages, replace:
See Migration Patterns for detailed examples. |
Summary
Three doc comments were using
<lane>,<path>and[options]unescaped, causing the strict-rustdoc CI gate (.github/workflows/docs.yml,RUSTDOCFLAGS="-D warnings") to fail withinvalid-html-tagsandbroken-intra-doc-linkserrors. The failures were latent onmainsince 2026-05-15 because the workflow only triggers oncrates/**/*.rs,Cargo.{toml,lock}and the workflow file itself — any push that doesn't touch a Rust file silently leaves docs red.Files touched:
crates/cli/src/commands/mod.rs— wrap<lane>/lane-init.jsonin backtickscrates/tools/src/bin/validate_adr.rs— move usage / options into a fencedtextblockcrates/tools/src/bin/generate_docs_index.rs— same treatmentNo behavior change; documentation only.
Verification
Safety
Documentation-only change. No RT path, IPC, hardware, or signature code touched.
Generated by Claude Code