Skip to content

docs: say CLAUDE.md is a symlink to AGENTS.md - #58

Merged
PastaPastaPasta merged 1 commit into
mainfrom
docs/agents-md-symlink-wording
Nov 10, 2026
Merged

PastaPastaPasta merged 1 commit into
mainfrom
docs/agents-md-symlink-wording

Conversation

@PastaPastaPasta

@PastaPastaPasta PastaPastaPasta commented Nov 10, 2026 •

Copy link
Copy Markdown
Member

AGENTS.md opens by saying "CLAUDE.md imports it". That was true of the first version of the change, but what merged makes CLAUDE.md a symlink. Someone reading the old sentence could edit CLAUDE.md thinking it is a separate Claude-only file (the edit would land in AGENTS.md for every agent), or turn it back into an import, which Claude Code does not load from subdirectories.

The sentence now says CLAUDE.md is a symlink to this file.

Tested: one-line docs change; CLAUDE.md is still mode 120000 pointing at AGENTS.md.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified that one project guidance document is linked to another rather than imported. This makes the documented relationship more precise and consistent with the current setup. The change is limited to documentation; application behavior and public interfaces remain unchanged, and no user-facing features were added or removed.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

AGENTS.md now describes CLAUDE.md as a symlink to AGENTS.md, replacing the statement that it imports the file.

Changes: Agent guidance

Layer / File(s) Summary
Correct the file relationship
AGENTS.md
The guidance describes CLAUDE.md as a symlink to AGENTS.md.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Possibly related PRs

  • dashpay/dash-bridge#57: PR #57 moved the agent guidance to AGENTS.md and described CLAUDE.md as an import. This change corrects that description.
Merge Risk: Minimal · up to 21114

The documentation accurately describes the existing link; no merge-blocking risk was found.

Pre-merge checks: Passed 5

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly describes the documentation change: it says that CLAUDE.md is a symlink to AGENTS.md.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 97c9af34-1ac0-4a07-8bf5-aa9b1028c84f
Commits

Reviewing files that changed from the base of the PR and between 9ccf61d and 2111414.

Files selected for processing: 1

  • AGENTS.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@PastaPastaPasta
PastaPastaPasta merged commit c034bf9 into main Nov 10, 2026
4 checks passed
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