Skip to content

docs: update AGENTS.md with architecture and tooling details - #469

Merged
lskramarov merged 2 commits into
mainfrom
docs/update-agents-md
Sep 8, 2026
Merged

lskramarov merged 2 commits into
mainfrom
docs/update-agents-md

Conversation

@lskramarov

@lskramarov lskramarov commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Expanded contributor and repository guidance, including project structure, build commands, CI requirements, testing, localization, responsive design, API review, Storybook, CSS, and design-token conventions.
    • Added guidance for package exports, optional dependencies, logging, commits, and agent workflows.
    • Clarified the purpose and usage of the Claude Code guidance document.
    • Added more detailed conventions for component development, package entry points, API approval, and repository automation.

@lskramarov lskramarov self-assigned this Sep 7, 2026
Copilot AI lite review requested due to automatic review settings September 7, 2026 08:02
@lskramarov lskramarov added the enhancement New feature or request label Sep 7, 2026
@coderabbitai

coderabbitai Bot commented Sep 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 800106a8-9f85-474e-9642-2690a152c547

📥 Commits

Reviewing files that changed from the base of the PR and between 1f5bbd8 and dcf1067.

📒 Files selected for processing (1)
  • AGENTS.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • AGENTS.md

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


📝 Walkthrough

Walkthrough

The pull request expands AGENTS.md with repository, package, component, styling, API, testing, and workflow guidance. It adds a heading and purpose statement to CLAUDE.md.

Changes

Repository guidance

Layer / File(s) Summary
Repository structure and package context
AGENTS.md
Documents repository structure, technology metadata, package layering, entry points, build outputs, and React Aria architecture.
Component implementation conventions
AGENTS.md
Adds guidance for components, localization, providers, responsive props, Storybook, MDX, CSS, and deprecation.
Validation and agent workflow
AGENTS.md, CLAUDE.md
Expands API Extractor, formatting, linting, testing, commit, Storybook MCP, pre-commit, and validation guidance. Adds the CLAUDE.md purpose statement.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to dcf10

This change updates repository guidance documentation only, with no identified merge-readiness risk.

Suggested reviewers: kamilemeleev

🚥 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 clearly and concisely describes the main change: updating AGENTS.md with architecture and tooling details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/update-agents-md

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.

@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown

Visit the preview URL for this PR (updated for commit dcf1067):

https://react-koobiq-next--prs-469-q3zhb6b4.web.app

(expires Sat, 12 Sep 2026 17:58:39 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: fc29847d4a9e5cb1adf458c76a9b681c76e2eeff

Copilot AI 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.

🟡 Changes recommended

The updated repository tree documentation is inaccurate because it omits an existing root file (vitest.workspace.ts).

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Updates contributor-facing agent documentation to better describe the repository architecture, tooling, and contributor workflows, and introduces a CLAUDE.md entrypoint that includes AGENTS.md.

Changes:

  • Added a short header to CLAUDE.md and kept @AGENTS.md as the included guidance.
  • Expanded AGENTS.md with clearer package layering, build/entrypoint details, CI command list, and component architecture conventions.
File summaries
File Description
CLAUDE.md Adds a minimal header/description and includes AGENTS.md as the primary guidance source.
AGENTS.md Substantially expands and clarifies repository architecture/tooling documentation (tree, commands, CI, conventions).
Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
@lskramarov
lskramarov merged commit 43bc82b into main Sep 8, 2026
7 checks passed
@lskramarov
lskramarov deleted the docs/update-agents-md branch September 8, 2026 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants