Skip to content

docs: consolidate agent files#568

Merged
spashii merged 1 commit into
mainfrom
clean-docs-may-12-2026
May 12, 2026
Merged

docs: consolidate agent files#568
spashii merged 1 commit into
mainfrom
clean-docs-may-12-2026

Conversation

@spashii
Copy link
Copy Markdown
Member

@spashii spashii commented May 12, 2026

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

    • Reorganized and consolidated internal developer guidelines across configuration files for improved maintainability.
  • Chores

    • Removed outdated configuration rules and wizard reports.

Note: No user-facing features or functionality changes in this release.

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>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 12, 2026

Walkthrough

This PR consolidates assistant and developer guidance across the Echo codebase. The main echo/AGENTS.md is rewritten to centralize cross-cutting rules (Directus, LLM routing, Dramatiq, transcription, brand, UI patterns), subdirectory-specific AGENTS files now point to the central rules, CLAUDE.md is updated to reference the consolidated guidance, a Cursor async-threadpool rule is removed, and a PostHog setup report is dropped. Documentation moves from distributed to centralized with targeted subdirectory guidance.

Changes

Documentation Consolidation & Structure Refactor

Layer / File(s) Summary
Central AGENTS ruleset
echo/AGENTS.md
Consolidated all cross-cutting rules: Directus/SDK behaviors, LLM model groups & failover, Dramatiq/async constraints, transcription workflow, translation/feature-flag conventions, brand & UI copy, branching/deployment, and project management. Added explicit maintenance protocol and Q&A tagging conventions.
Subdirectory-specific AGENTS guidance
echo/frontend/AGENTS.md, echo/server/AGENTS.md
Rewritten to reference central @AGENTS.md for global rules and focus on subdirectory-specific patterns only: frontend handles React Query, Lingui, Mantine, PostHog analytics, modal conventions, and theming; server covers uv run entrypoints, Directus-over-SQLAlchemy preference, settings access, Dramatiq design, worker tuning, and agentic runtime behavior.
Top-level CLAUDE.md alignment
echo/CLAUDE.md
Removed duplicated ECHO codebase rules; now points to centralized @AGENTS.md, subdirectory-specific guidance, and adds Claude-Code-specific operational notes (Explore/Plan usage, /security-review triggers, memory/skills config).
Cleanup
echo/.cursor/rules/async-threadpool.mdc, echo/frontend/posthog-setup-report.md
Removed Cursor rule enforcing run_in_thread_pool wrapping and removed PostHog integration status report.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • Dembrane/echo#329: Directly inverse to this PR—adds the removed async-threadpool.mdc Cursor rule and converts call sites to use run_in_thread_pool, while this PR removes the rule and guidance.

Suggested labels

documentation, improvement


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)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: consolidate agent files' directly and concisely summarizes the main change: consolidating multiple agent documentation files into a unified structure with AGENTS.md as the canonical source.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch clean-docs-may-12-2026

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4b6d044 and 7c7dd8f.

📒 Files selected for processing (6)
  • echo/.cursor/rules/async-threadpool.mdc
  • echo/AGENTS.md
  • echo/CLAUDE.md
  • echo/frontend/AGENTS.md
  • echo/frontend/posthog-setup-report.md
  • echo/server/AGENTS.md
💤 Files with no reviewable changes (2)
  • echo/frontend/posthog-setup-report.md
  • echo/.cursor/rules/async-threadpool.mdc

Comment thread echo/frontend/AGENTS.md
Comment on lines +47 to +50
```tsx
// Instead of: className="bg-parchment"
style={{ backgroundColor: "var(--app-background)" }}
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

@ussaama ussaama self-requested a review May 12, 2026 11:24
@spashii spashii added this pull request to the merge queue May 12, 2026
Merged via the queue into main with commit 1d7cfbd May 12, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants