docs: add AGENTS.md configuration for Claude Code #805
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Create AGENTS.md (with CLAUDE.md symlink) to document the Mix monorepo structure, essential melos commands, core architecture patterns, and critical rules for working effectively with the codebase in Claude Code.
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
To view this pull requests documentation preview, visit the following URL: Documentation is deployed and generated using docs.page. |
- Remove CLAUDE.md from .gitignore to version the symlink - Add guides section referencing api-composition-guidelines.md
- Update title to Mix 2.0 - Replace Patterns section with Examples (code samples) - Add Documentation section pointing to guides, examples, website - Add fluent chaining example
- Remove packages/mix/ai.txt (referenced Mix v1.7.0 with old cascade syntax) - Expand AGENTS.md documentation section with website docs references - Add links to styling, variants, tokens, and animation guides
- Use BoxStyler() fluent chaining (recommended API) - Fix variants: .onDark(), .onHovered() methods, not $on.dark() - Add $box cascade notation example - Remove incorrect $text.style.bold() syntax
Add technical research and validated implementation plans for: - symbolEffect: icon animations (bounce, pulse, wiggle, rotate, breathe) - matchedGeometryEffect: geometry-aware transitions The validated plan identifies over-engineering in the original proposal and provides a simplified approach reusing existing PhaseAnimationDriver.
Deprecate $box, $text, $icon, $flex, $image, $stack, etc. global accessors. Use BoxStyler(), TextStyler(), IconStyler() directly instead. Before (deprecated): final style = $box.color(Colors.red).size(100, 100); After (recommended): final style = BoxStyler().color(Colors.red).size(100, 100);
Update AGENTS.md and CLAUDE.md to only show the recommended BoxStyler() fluent API. The $box cascade notation is deprecated in Mix 2.0 in favor of the cleaner Styler class approach.
github-actions
bot
added
documentation
Collaborator
Author
|
Superseded by a new PR with cleaner branch name (feat/mix-2.0-styler-cleanup) and additional fixes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related issue
Improves developer experience for working in Claude Code.
Description
Added AGENTS.md (with CLAUDE.md symlink) to document the Mix monorepo structure, essential build and test workflows, core architecture patterns, and critical development rules. This enables Claude Code to work more effectively with the codebase by providing clear context about the project structure and conventions.
Changes
Review Checklist
Additional Information
This configuration helps Claude Code understand the project's monorepo structure and conventions, enabling better code suggestions and understanding of architectural patterns when working with the Mix framework.