docs(contributing): keep docs interlinked and DRY#102
Conversation
WalkthroughAdded two new documentation contribution guidelines to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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 |
Time Submission Status
You can submit time with the command. Example: See available commands to help comply with our Guidelines. |
|
@holdex pr submit-time 15m |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/CONTRIBUTING.md`:
- Around line 206-208: The two long sentences ("When adding new documentation
files, ensure they are reachable via interlinking from the root entry point. Do
not create orphaned files." and "Do not duplicate content across files. Each
piece of information — procedures, templates, configuration steps — must live in
exactly one place. Reference it from other docs rather than copying it.") exceed
the markdownlint MD013 max line length; reflow/wrap them to line lengths under
the configured limit without changing wording or semantics (use soft wraps or
split after natural punctuation), preserve paragraph structure and dashes, and
run the markdown linter to confirm MD013 now passes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 39dc2eb1-c73a-4bbe-9cb1-11d5f0545142
📒 Files selected for processing (1)
docs/CONTRIBUTING.md
|
@holdex pr submit-time 5m |
Two additions to the Scoping section, based on a recurring documentation fragmentation pattern:
Related
Summary by CodeRabbit