Coding Assistant Support

Learn how Shop Minis provide context to coding assistants for better development experience.

Anchor to OverviewOverview

Shop Mini projects include two context files that coding assistants automatically discover:

• AGENTS.md - The main context file containing Shop Mini development patterns, SDK guidelines, and best practices
• CLAUDE.md - A reference file for compatibility with specific tools

These files are included in every new project created with npx shop-minis create and provide coding assistants with the context they need to understand Shop Mini development.

Anchor to What It ProvidesWhat It Provides

The context files provide coding assistants with key Shop Mini topics:

• Development workflow - Setup commands, device testing, debugging techniques
• SDK-first component selection - When to use Shop Minis React components vs custom solutions
• Mobile-only design requirements - Touch targets, WebView constraints, performance limits
• Navigation and storage patterns - Shop app navigation, SDK storage hooks instead of Web APIs
• Project structure - Required files, TypeScript patterns, Tailwind CSS configuration
• Security and submission - Trusted domains, publishing requirements, common pitfalls to avoid

Anchor to CustomizationCustomization

You can customize the AGENTS.md file to include:

• Your Shop Mini's specific features and functionality
• Team coding conventions
• Project-specific patterns
• Custom components and hooks you've built

Simply edit the AGENTS.md file in your project root. Coding assistants will use your additions when generating suggestions.