docs: add AGENTS.md and CLAUDE.md SDK documentation#524
docs: add AGENTS.md and CLAUDE.md SDK documentation#524ignaciosantise merged 4 commits intodevelopfrom
Conversation
Add comprehensive AGENTS.md with SDK overview, architecture patterns, UI system details, and agent guidance. Add CLAUDE.md as a reference link to AGENTS.md. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
|
|
Claude finished @ignaciosantise's task —— View job PR Review Complete ✅
Review FindingsDocumentation Accuracy IssuesAGENTS.md:75 - Component count inaccuracy: ├── components/ # 13 base primitives (Card, Icon, Text, Image, Modal, etc.)
AGENTS.md:79 - Composite count accurate (42 ✓) AGENTS.md:164 - View count inaccuracy: **RouterController** manages navigation between 23 views:
AGENTS.md:90 - Partials count inaccuracy: └── partials/ # 24 AppKit-specific composites (Header, Snackbar, QrCode, etc.)
AGENTS.md:265 - Line count accuracy: packages/appkit/src/AppKit.ts # Main SDK class (~900 LOC)
AGENTS.md:97 - Missing base component:
AGENTS.md:119-146 - Theme system verification needed:
Missing View Types in DocumentationThe following views exist in RouterController but aren't mentioned in the documentation list (AGENTS.md:165-171):
CLAUDE.md AssessmentCLAUDE.md:1 - Minimal content: AGENTS.md
Positive Observations✅ Comprehensive SDK overview with clear architectural patterns Changeset AssessmentThe changeset-bot correctly flagged that no changeset was added. For documentation-only changes, a changeset is typically not required unless your project's policy differs. However, if you want these docs to be mentioned in release notes, consider adding a patch-level changeset with: yarn changeset addSelect "patch" for the relevant packages and describe it as documentation improvements. Recommendation: Fix the numerical inaccuracies before merging to ensure agents have accurate information about the codebase structure. |
There was a problem hiding this comment.
Pull request overview
Adds agent/developer-facing SDK documentation intended to explain the AppKit React Native monorepo architecture, UI system, and development guidelines.
Changes:
- Added
AGENTS.mdwith SDK overview, patterns, UI/theming details, and agent guidance. - Added
CLAUDE.mdintended to point readers toAGENTS.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| CLAUDE.md | Adds a pointer to the main agent/developer documentation. |
| AGENTS.md | Introduces comprehensive documentation about repo structure, architecture patterns, UI/theming system, and workflow requirements. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Fix base components count (13 → 11) - Fix React Native version (0.76+ → 0.72+ with tested note) - Fix typography variants (24 → 23, add 700 weight) - Clarify animation patterns (native driver vs JS-driven) - Update RouterController views to reference source file Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
ignaciosantise
left a comment
There was a problem hiding this comment.
Thanks for the thorough review! I've addressed all the feedback:
- Base components count: Fixed to 11 ✓
- RouterController views: Now references source file instead of hardcoded list ✓
- Animation patterns: Clarified native driver vs JS-driven animations ✓
- Typography variants: Fixed to 23 variants with 400/500/600/700 weights ✓
- React Native version: Updated to 0.72+ (tested with 0.76+) ✓
- CLAUDE.md link: Keeping as plain text per project maintainer's request
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
|



Summary
Add comprehensive SDK documentation files to help agents and developers understand the AppKit React Native architecture and development guidelines.
This documentation covers the monorepo structure, controller/adapter/connector patterns, theming system, UI components, and code quality requirements including formatting, linting, testing, and dependency policies.
🤖 Generated with Claude Code
Note
Adds SDK documentation for reviewers and agents.
AGENTS.mdWritten by Cursor Bugbot for commit 36db6f7. This will update automatically on new commits. Configure here.