Skip to content

feat(coderabbit): add docs-staleness check for src/ changes#2042

Merged
alexeyv merged 1 commit intomainfrom
feat/coderabbit-docs-check
Mar 17, 2026
Merged

feat(coderabbit): add docs-staleness check for src/ changes#2042
alexeyv merged 1 commit intomainfrom
feat/coderabbit-docs-check

Conversation

@alexeyv
Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv commented Mar 17, 2026

Summary

  • Adds a path_instructions entry for src/** that tells CodeRabbit to flag when documentation under docs/ may need updating whenever source files are modified
  • Covers new features, changed behavior, renamed concepts, altered CLI flags, and modified configuration options
  • Stacks additively with existing path-specific instructions (skills, workflows, tasks, agents)

Test plan

  • Open a PR that modifies a file under src/ and verify CodeRabbit includes the docs-staleness check in its review
  • Open a PR that only modifies files outside src/ and verify the instruction does not fire

🤖 Generated with Claude Code

Adds a path_instructions entry so CodeRabbit flags when documentation
under docs/ may need updating whenever source files are modified.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@augmentcode
Copy link
Copy Markdown

augmentcode Bot commented Mar 17, 2026

🤖 Augment PR Summary

Summary: Adds a CodeRabbit path_instructions rule for src/** to flag potentially stale documentation under docs/ when source files change.
Why: Encourages doc updates alongside new/changed behavior, renamed concepts, CLI flags, and configuration options.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode Bot left a comment

Choose a reason for hiding this comment

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

Review completed. No suggestions at this time.

Comment augment review to trigger a new review at any time.

@alexeyv alexeyv merged commit f3f606a into main Mar 17, 2026
7 checks passed
@alexeyv alexeyv deleted the feat/coderabbit-docs-check branch March 17, 2026 21:37
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.

1 participant