docs: add AI-friendly documentation and code comments
Add comprehensive documentation for AI assistants: - .cursorrules with project context and conventions - ARCHITECTURE.md with technical details - DEVELOPMENT.md with practical guides - JSDoc comments in all JavaScript modules - Update README.md with AI-Friendly Development section This enables AI tools (Cursor, Claude Code, GitHub Copilot) to understand the project and generate code following CoreUI Vue patterns.
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# CoreUI Free Vue Admin Template [](https://twitter.com/intent/tweet?text=CoreUI%20-%20Free%Vue%204%20Admin%20Template%20&url=https://coreui.io&hashtags=bootstrap,admin,template,dashboard,panel,free,angular,react,vue)
|
||||
# CoreUI Free Vue Admin Template - Built for AI-Assisted Development [](https://twitter.com/intent/tweet?text=CoreUI%20-%20Free%Vue%204%20Admin%20Template%20&url=https://coreui.io&hashtags=bootstrap,admin,template,dashboard,panel,free,angular,react,vue)
|
||||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://github.com/coreui/coreui)
|
||||
@@ -29,6 +29,7 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of
|
||||
* [Installation](#installation)
|
||||
* [Basic usage](#basic-usage)
|
||||
* [What's included](#whats-included)
|
||||
* [AI-Friendly Development](#ai-friendly-development)
|
||||
* [Documentation](#documentation)
|
||||
* [Components](#components)
|
||||
* [Versioning](#versioning)
|
||||
@@ -135,6 +136,43 @@ coreui-free-vue-admin-template
|
||||
└── vite.config.mjs
|
||||
```
|
||||
|
||||
## AI-Friendly Development
|
||||
|
||||
This template is designed to work seamlessly with AI coding assistants like Cursor, GitHub Copilot, and Claude Code. We've included comprehensive documentation and configuration files to help AI understand the project structure and conventions.
|
||||
|
||||
### Features for AI Development
|
||||
|
||||
- **`.cursorrules`**: Complete AI assistant configuration with project conventions, technology stack, and coding patterns
|
||||
- **`ARCHITECTURE.md`**: Detailed technical architecture documentation covering components, routing, state management, and build system
|
||||
- **`DEVELOPMENT.md`**: Comprehensive development guide with setup instructions, workflows, and best practices
|
||||
- **JSDoc Comments**: Main Vue components include documentation for better AI understanding
|
||||
|
||||
### Getting Started with AI Assistants
|
||||
|
||||
1. **Open the project** in your AI-powered IDE (VS Code with Cursor, GitHub Copilot, or Claude Code)
|
||||
2. **Review `.cursorrules`** to understand the project conventions
|
||||
3. **Ask your AI assistant** to help you build features - it will automatically follow the project patterns
|
||||
4. **Use natural language** to describe components, pages, or features you want to add
|
||||
|
||||
### What AI Assistants Know About This Project
|
||||
|
||||
Your AI assistant understands:
|
||||
- **Component Library**: Always use CoreUI Vue components (never Tailwind, Vuetify, or other libraries)
|
||||
- **Code Style**: Vue 3 Composition API with `<script setup>` syntax, Prettier formatting, ESLint rules
|
||||
- **Architecture**: Single Page Application with Vue Router, Pinia for state management, Vite for building
|
||||
- **File Organization**: Where to create components, views, routes, and styles
|
||||
- **Common Patterns**: Lazy loading, composables, navigation configuration, theming
|
||||
|
||||
### Example AI Prompts
|
||||
|
||||
Try asking your AI assistant:
|
||||
- "Create a new products page with a table showing product name, price, and status"
|
||||
- "Add a user profile form with validation"
|
||||
- "Create a chart showing monthly sales data"
|
||||
- "Add a new navigation item for the settings page"
|
||||
|
||||
For more information, see the [DEVELOPMENT.md](DEVELOPMENT.md) guide.
|
||||
|
||||
## Documentation
|
||||
|
||||
The documentation for the CoreUI Admin Template is hosted at our website [CoreUI for Vue](https://coreui.io/vue/docs/templates/installation.html)
|
||||
|
||||
Reference in New Issue
Block a user