docs: consolidate agent files#568
Conversation
AGENTS.md is now the cross-tool source of truth; CLAUDE.md is a thin @import shim. Removed content discoverable from package.json, git log, or one file read. .cursor/rules folded in (Cursor reads AGENTS.md natively). posthog-setup-report folded into frontend/AGENTS.md as the Analytics section. Maintenance protocol triggers on user input, not on pattern-occurrence counts. Net: 37 KB -> 17 KB. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
WalkthroughThis PR consolidates assistant and developer guidance across the Echo codebase. The main ChangesDocumentation Consolidation & Structure Refactor
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
LGTM. Clean consolidation of guidance—reduced duplication, clear reference structure, and subdirectory specificity maintained. The async-threadpool rule removal aligns with the guidance shift. ✓ 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@echo/frontend/AGENTS.md`:
- Around line 47-50: The fenced tsx code block in AGENTS.md is missing required
blank lines before and after the ```tsx fence (MD031); fix by inserting a blank
line immediately above the opening ```tsx and another blank line immediately
below the closing ``` so the block containing the lines "// Instead of:
className=\"bg-parchment\"" and "style={{ backgroundColor:
\"var(--app-background)\" }}" is separated from surrounding text and conforms to
Markdown lint rules.
🪄 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: ASSERTIVE
Plan: Pro
Run ID: 04624632-1d3a-4201-9475-2e78b7bfc5b8
📒 Files selected for processing (6)
echo/.cursor/rules/async-threadpool.mdcecho/AGENTS.mdecho/CLAUDE.mdecho/frontend/AGENTS.mdecho/frontend/posthog-setup-report.mdecho/server/AGENTS.md
💤 Files with no reviewable changes (2)
- echo/frontend/posthog-setup-report.md
- echo/.cursor/rules/async-threadpool.mdc
| ```tsx | ||
| // Instead of: className="bg-parchment" | ||
| style={{ backgroundColor: "var(--app-background)" }} | ||
| ``` |
There was a problem hiding this comment.
Fix fenced-code spacing to satisfy Markdown lint.
Line 47 and Line 50 need blank lines around the fenced tsx block (MD031).
Proposed fix
- - For Tailwind classes that need theme values, replace with inline `style`:
- ```tsx
+ - For Tailwind classes that need theme values, replace with inline `style`:
+
+ ```tsx
// Instead of: className="bg-parchment"
style={{ backgroundColor: "var(--app-background)" }}
```
+🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 47-47: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 50-50: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@echo/frontend/AGENTS.md` around lines 47 - 50, The fenced tsx code block in
AGENTS.md is missing required blank lines before and after the ```tsx fence
(MD031); fix by inserting a blank line immediately above the opening ```tsx and
another blank line immediately below the closing ``` so the block containing the
lines "// Instead of: className=\"bg-parchment\"" and "style={{ backgroundColor:
\"var(--app-background)\" }}" is separated from surrounding text and conforms to
Markdown lint rules.
AGENTS.md is now the cross-tool source of truth; CLAUDE.md is a thin @import shim. Removed content discoverable from package.json, git log, or one file read. .cursor/rules folded in (Cursor reads AGENTS.md natively). posthog-setup-report folded into frontend/AGENTS.md as the Analytics section. Maintenance protocol triggers on user input, not on pattern-occurrence counts.
Summary by CodeRabbit
Documentation
Chores
Note: No user-facing features or functionality changes in this release.