Skip to content

docs(claude): add code-references rule to scratchpads workflow#312

Merged
couimet merged 1 commit intomainfrom
side-quest/claude-md-code-references-rule
Feb 6, 2026
Merged

docs(claude): add code-references rule to scratchpads workflow#312
couimet merged 1 commit intomainfrom
side-quest/claude-md-code-references-rule

Conversation

@couimet
Copy link
Owner

@couimet couimet commented Feb 6, 2026

Discovered while working on PR #308 that scratchpads are much more useful when code references use RangeLink-format clickable links instead of plain text like "(lines 26-37)". Also documents that wrapping links in backticks breaks RangeLink navigation (tracked in #310).

Benefits:

  • Scratchpad references become one-click navigable
  • Prevents the backtick-wrapping pitfall that breaks link parsing

Summary by CodeRabbit

  • Documentation
    • Added code-references guidance blocks to two documentation sections with formatting instructions, accepted formats, and examples.

Discovered while working on PR #308 that scratchpads are much more useful when code references use RangeLink-format clickable links instead of plain text like "(lines 26-37)". Also documents that wrapping links in backticks breaks RangeLink navigation (tracked in #310).

Benefits:
- Scratchpad references become one-click navigable
- Prevents the backtick-wrapping pitfall that breaks link parsing
@couimet couimet merged commit 5af3a43 into main Feb 6, 2026
1 of 2 checks passed
@couimet couimet deleted the side-quest/claude-md-code-references-rule branch February 6, 2026 19:29
@coderabbitai
Copy link

coderabbitai bot commented Feb 6, 2026

Caution

Review failed

The pull request is closed.

Walkthrough

Added code-references guidance blocks to two "when-NOT-to-use" sections in CLAUDE.md—one in the main workflow and one in the scratchpads workflow. Each block provides instructions on RangeLink-format usage, workspace-relative paths, and formatting examples without altering any logic.

Changes

Cohort / File(s) Summary
Documentation Updates
CLAUDE.md
Added identical code-references guidance blocks to two sections with instructions on using RangeLink-format, workspace-relative paths, accepted formats, and examples of correct and incorrect usage patterns.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Two sections now shine bright,
With guidance on references done right,
RangeLink paths and formats clear,
No logic changed, just wisdom here! ✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch side-quest/claude-md-code-references-rule

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.

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