LLM Setup Guide

Configure your AI tools to work seamlessly with Aki UI components using the llms.txt standard.

LLMs.txt Resources

📄 Standard Documentation

Concise overview and component information for quick AI context.

https://aki-ui.akitect.io/llms.txt
Recommended for most use cases

📚 Full Documentation

Complete API reference with detailed examples and best practices.

https://aki-ui.akitect.io/llms-full.txt
For comprehensive projects

Setup by AI Tool

GitHub Copilot Setup

Method 1: Chat Context

Share the llms.txt URL in your Copilot chat for immediate context:

Please use this documentation for Aki UI components: https://aki-ui.akitect.io/llms.txt

Help me create a contact form using Aki UI components.

Method 2: Workspace Context

Add a reference file to your project:

# Create a docs reference file
echo "Aki UI Documentation: https://aki-ui.akitect.io/llms.txt" > .github/copilot-instructions.md

Method 3: Comment Instructions

Add comments in your code files:

// Aki UI Documentation: https://aki-ui.akitect.io/llms.txt
// Use Aki UI components for this React component

import { Button, Card } from '@akitectio/aki-ui'

export default function MyComponent() {
  // Component implementation
}

Best Practices

🎯 Effective Prompting

  • • Start with documentation URL context
  • • Be specific about component requirements
  • • Mention accessibility and responsive needs
  • • Request TypeScript types when needed
  • • Ask for best practices and examples

📝 Project Setup

  • • Add llms.txt URL to project README
  • • Include Aki UI in dependency documentation
  • • Create component usage examples
  • • Document your theming approach
  • • Maintain consistent import patterns

🔄 Iterative Development

  • • Start with basic component structure
  • • Add props and customization gradually
  • • Request responsive design iterations
  • • Ask for accessibility improvements
  • • Optimize for performance when needed

🛠 Troubleshooting

  • • Share specific error messages
  • • Provide component code context
  • • Mention Aki UI version being used
  • • Include relevant TypeScript errors
  • • Ask for alternative approaches

Example Workflows

Creating a New Component

Step 1: Provide context

"Using Aki UI documentation at https://aki-ui.akitect.io/llms.txt, help me create..."

Step 2: Specify requirements

"The component should be responsive, accessible, and use TypeScript"

Step 3: Request examples

"Show me usage examples and best practices"

Debugging Issues

Share context:

"I'm using Aki UI (https://aki-ui.akitect.io/llms.txt) and getting this error..."

Provide code:

"Here's my component code and the specific issue I'm facing"

Testing Your Setup

Verify your AI tool setup with these test prompts:

Basic Test

"Using Aki UI documentation, show me how to create a simple button with different variants"

Advanced Test

"Create a responsive card grid using Aki UI components with proper TypeScript types"

Integration Test

"Build a complete contact form with validation using Aki UI form components"