docs: add pre-pr doc cross-link audit#31
Merged
flyingrobots merged 3 commits intomainfrom Apr 1, 2026
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds a landed TR-009 “Pre-PR Doc Cross-Link Audit” to documentation workflows: new design doc, checklist entry, WORKFLOW/CONTRIBUTING updates, backlog archival moves, and legend/index updates to require a lightweight pre-review cross-link verification for doc-heavy branches. Changes
Sequence Diagram(s)(omitted — changes are documentation/metadata updates without multi-component control-flow requiring visualization) Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/design/TR-009-pre-pr-doc-cross-link-audit.md (1)
97-100: Consider making trigger targets explicit as filenames or “doc surfaces.”The current list mixes conceptual surfaces and filename-like labels. Making this explicit (for example,
README.md,CONTRIBUTING.md, etc., or “canonical doc surfaces such as …”) would reduce interpretation drift for maintainers/agents.Proposed wording tweak
-The audit should run when a branch changes top-level or canonical docs such as -README, CONTRIBUTING, WORKFLOW, ARCHITECTURE, SECURITY, API, THREAT_MODEL, -BENCHMARKS, and planning indexes. +The audit should run when a branch changes top-level or canonical doc surfaces +such as README.md, CONTRIBUTING.md, WORKFLOW.md, ARCHITECTURE.md, SECURITY.md, +API.md, THREAT_MODEL.md, BENCHMARKS.md, and planning indexes.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/design/TR-009-pre-pr-doc-cross-link-audit.md` around lines 97 - 100, Update the ambiguous trigger-target wording in TR-009-pre-pr-doc-cross-link-audit.md so it lists explicit filename targets or clearly labels them as “canonical doc surfaces”; replace the current mixed terms (README, CONTRIBUTING, WORKFLOW, ARCHITECTURE, SECURITY, API, THREAT_MODEL, BENCHMARKS, and planning indexes) with explicit examples like README.md, CONTRIBUTING.md, WORKFLOW.md, ARCHITECTURE.md, SECURITY.md, API.md, THREAT_MODEL.md, BENCHMARKS.md (or the phrase “canonical doc surfaces such as …”) so maintainers/agents cannot misinterpret which files should trigger the audit.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/design/TR-009-pre-pr-doc-cross-link-audit.md`:
- Around line 97-100: Update the ambiguous trigger-target wording in
TR-009-pre-pr-doc-cross-link-audit.md so it lists explicit filename targets or
clearly labels them as “canonical doc surfaces”; replace the current mixed terms
(README, CONTRIBUTING, WORKFLOW, ARCHITECTURE, SECURITY, API, THREAT_MODEL,
BENCHMARKS, and planning indexes) with explicit examples like README.md,
CONTRIBUTING.md, WORKFLOW.md, ARCHITECTURE.md, SECURITY.md, API.md,
THREAT_MODEL.md, BENCHMARKS.md (or the phrase “canonical doc surfaces such as
…”) so maintainers/agents cannot misinterpret which files should trigger the
audit.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1169c298-6589-43f2-a43d-d7deddb3f8a9
📒 Files selected for processing (10)
CHANGELOG.mdCONTRIBUTING.mdWORKFLOW.mddocs/BACKLOG/README.mddocs/DOCS_CHECKLIST.mddocs/archive/BACKLOG/README.mddocs/archive/BACKLOG/TR-009-pre-pr-doc-cross-link-audit.mddocs/design/README.mddocs/design/TR-009-pre-pr-doc-cross-link-audit.mddocs/legends/TR-truth.md
💤 Files with no reviewable changes (1)
- docs/BACKLOG/README.md
Member
Author
|
@coderabbitai review please 🥕 |
|
🧠 Learnings used✅ Actions performedReview triggered.
|
This was referenced Apr 1, 2026
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
1 participant
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
Verification
Summary by CodeRabbit