Skip to content

docs(contributing): keep docs interlinked and DRY#102

Merged
markholdex merged 2 commits intomainfrom
docs/documentation-structure-guidelines
Apr 23, 2026
Merged

docs(contributing): keep docs interlinked and DRY#102
markholdex merged 2 commits intomainfrom
docs/documentation-structure-guidelines

Conversation

@zolotokrylin
Copy link
Copy Markdown
Member

@zolotokrylin zolotokrylin commented Apr 23, 2026

Two additions to the Scoping section, based on a recurring documentation fragmentation pattern:

  • New doc files must be reachable via interlinking from the root entry point — no orphaned files
  • Content must live in exactly one place; other docs reference it rather than copying it

Related

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines to require new documentation be discoverable through root-level interlinking and to prevent orphaned pages within the documentation structure.
    • Added requirement that documentation content must not be duplicated across multiple files; instead, content should be referenced from other documentation files to maintain consistency.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 23, 2026

Walkthrough

Added two new documentation contribution guidelines to docs/CONTRIBUTING.md: requiring that new documentation be discoverable from the root through interlinking (no orphaned docs) and prohibiting content duplication across multiple files.

Changes

Cohort / File(s) Summary
Documentation Guidelines
docs/CONTRIBUTING.md
Added two new PR requirements for documentation: discoverability/interlinking mandate and duplication prohibition with cross-reference guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • markholdex
  • dante4rt
  • matthewvogas
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately summarizes the main change: adding documentation rules about keeping docs interlinked and avoiding duplication (DRY principle).

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/documentation-structure-guidelines

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@holdex
Copy link
Copy Markdown

holdex Bot commented Apr 23, 2026

Time Submission Status

Member Status Time Action Last Update
zolotokrylin ✅ Submitted 15min Update time Apr 23, 2026, 6:25 AM
markholdex ✅ Submitted 5min Update time Apr 23, 2026, 6:28 AM

You can submit time with the command. Example:

@holdex pr submit-time 15m

See available commands to help comply with our Guidelines.

@zolotokrylin
Copy link
Copy Markdown
Member Author

@holdex pr submit-time 15m

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 33f7da5 and 16c2e8e.

📒 Files selected for processing (1)
  • docs/CONTRIBUTING.md

Comment thread docs/CONTRIBUTING.md Outdated
@zolotokrylin zolotokrylin changed the title docs(contributing): keep docs interlinked and avoid content duplication docs(contributing): keep docs interlinked and DRY Apr 23, 2026
@markholdex
Copy link
Copy Markdown
Contributor

@holdex pr submit-time 5m

@markholdex markholdex merged commit cb25755 into main Apr 23, 2026
4 checks passed
@markholdex markholdex deleted the docs/documentation-structure-guidelines branch April 23, 2026 06:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants