Skip to content

docs: consolidate agent guidance into AGENTS.md, symlink CLAUDE.md#291

Merged
vihar merged 1 commit into
masterfrom
chore/agents-md-canonical
Jun 18, 2026
Merged

docs: consolidate agent guidance into AGENTS.md, symlink CLAUDE.md#291
vihar merged 1 commit into
masterfrom
chore/agents-md-canonical

Conversation

@sriramveeraghanta

Copy link
Copy Markdown
Member

What

Consolidates all agent-facing repo guidance into a single canonical AGENTS.md and turns CLAUDE.md into a symlink pointing to it.

Why

CLAUDE.md and AGENTS.md had drifted into two complementary-but-separate files:

  • CLAUDE.md — project overview, commands, architecture, custom Vue components, API doc pattern, conventions.
  • AGENTS.md — directory map, key documentation paths, important notes.

AGENTS.md is the cross-tool standard (Claude Code, Codex, Cursor, …). Merging into it with a CLAUDE.md symlink gives every agent one source of truth and removes the drift risk.

How

  • AGENTS.md now contains the union of both files, organized into Project Overview → Commands → Architecture (+ directory tree) → Key Documentation Paths → Custom Vue Components → API Documentation Pattern → Conventions → Important Notes.
  • CLAUDE.md is now a symlink → AGENTS.md (git mode 120000), so it resolves to identical content.
  • Refreshed stale references for the recent restructure: self-hosting/govern/plane-ai.md → the plane-ai/ directory; added the pnpm check:types command.

Notes

  • pnpm check:format passes.
  • No site content changes — both files live at the repo root, outside the VitePress docs/ tree.

Merge the project overview, commands, architecture, custom-component
reference, API doc pattern, and conventions from CLAUDE.md together with
the directory map and key documentation paths from AGENTS.md into a single
canonical AGENTS.md (the cross-tool standard). CLAUDE.md is now a symlink to
AGENTS.md so Claude Code and other agents share one source of truth.

Also refresh stale paths for the recent restructure: plane-ai.md is now the
plane-ai/ directory, and add the pnpm check:types command.
@vercel

vercel Bot commented Jun 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
developer-docs Ready Ready Preview, Comment Jun 18, 2026 8:02pm

Request Review

@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@sriramveeraghanta, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 40 minutes and 59 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 19382f21-e61a-4b0a-946e-603c9505e05d

📥 Commits

Reviewing files that changed from the base of the PR and between f979242 and 3afd522.

📒 Files selected for processing (3)
  • AGENTS.md
  • CLAUDE.md
  • CLAUDE.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/agents-md-canonical

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.

@vihar vihar merged commit f6749a7 into master Jun 18, 2026
8 checks passed
@vihar vihar deleted the chore/agents-md-canonical branch June 18, 2026 20:09
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