Skip to content

chore: use AGENTS.md as canonical agent instructions - #431

Closed
iiio2 wants to merge 1 commit into
we-dance:mainfrom
iiio2:main
Closed

chore: use AGENTS.md as canonical agent instructions#431
iiio2 wants to merge 1 commit into
we-dance:mainfrom
iiio2:main

Conversation

@iiio2

@iiio2 iiio2 commented Jun 18, 2026

Copy link
Copy Markdown
Member

Let's use AGENTS.md as canonical agent instructions.

Summary by CodeRabbit

  • Chores
    • Updated internal project documentation and structure for development reference.

@vercel

vercel Bot commented Jun 18, 2026

Copy link
Copy Markdown

Someone is attempting to deploy a commit to the WeDance Team on Vercel.

A member of the Team first needs to authorize it.

@iiio2
iiio2 requested a review from razbakov June 18, 2026 03:32
@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The full WeDance v4 project documentation previously in CLAUDE.md is moved to a new AGENTS.md file. CLAUDE.md is reduced to a single line referencing @AGENTS.md.

Changes

Documentation Consolidation

Layer / File(s) Summary
Create AGENTS.md and redirect CLAUDE.md
AGENTS.md, CLAUDE.md
AGENTS.md is introduced with 75 lines covering the project overview, tech stack, local dev commands, directory structure, key modules, deployment/CI/Docker/Trigger.dev config, and governance reference. CLAUDE.md is reduced to a single @AGENTS.md pointer, removing its prior duplicate content.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A bunny moved the docs with care,
From CLAUDE to AGENTS, fresh and fair.
One pointer left where pages stood,
The warren's tidy — as it should!
🐇✨

🚥 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 accurately describes the main change: establishing AGENTS.md as the canonical source by moving content from CLAUDE.md and creating a reference structure.
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

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
AGENTS.md (1)

39-54: ⚡ Quick win

Add language specification to the directory structure code block.

The fenced code block at line 39 is missing a language identifier. Add a language specifier (e.g., text) to comply with markdown best practices and resolve the linter warning.

✏️ Proposed fix
-```
+```text
 pages/                # Routes (events, profiles, cities, checkout, chat, admin)
 components/           # Vue components (ui/, common/, feature-specific)
🤖 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 `@AGENTS.md` around lines 39 - 54, The fenced code block containing the
directory structure listing (pages/, components/, server/, etc.) is missing a
language identifier after the opening triple backticks. Add the language
specifier text to the opening fence by changing the opening ``` to ```text to
comply with markdown linting standards and improve code block formatting.

Source: Linters/SAST tools

🤖 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.

Nitpick comments:
In `@AGENTS.md`:
- Around line 39-54: The fenced code block containing the directory structure
listing (pages/, components/, server/, etc.) is missing a language identifier
after the opening triple backticks. Add the language specifier text to the
opening fence by changing the opening ``` to ```text to comply with markdown
linting standards and improve code block formatting.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b731bd9e-2d64-46a6-b939-b11472eeebcc

📥 Commits

Reviewing files that changed from the base of the PR and between b7c70c6 and a05af95.

📒 Files selected for processing (2)
  • AGENTS.md
  • CLAUDE.md

@razbakov razbakov left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

No. This breaks Claude Code

@iiio2

iiio2 commented Jun 18, 2026

Copy link
Copy Markdown
Member Author

really? Ok.

@iiio2 iiio2 closed this Jun 18, 2026
@github-project-automation github-project-automation Bot moved this from Triage to Released in v4 Launch Jun 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Released

Development

Successfully merging this pull request may close these issues.

2 participants