From 7e6a087049444b0d2c5f0238fc2b40d118165469 Mon Sep 17 00:00:00 2001 From: mrholek Date: Wed, 1 Apr 2026 10:47:02 +0200 Subject: [PATCH] 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. --- .cursorrules | 349 ++++++++++++++ ARCHITECTURE.md | 716 ++++++++++++++++++++++++++++ DEVELOPMENT.md | 1113 +++++++++++++++++++++++++++++++++++++++++++ README.md | 40 +- src/App.vue | 14 + src/_nav.js | 23 + src/main.js | 34 +- src/router/index.js | 28 ++ 8 files changed, 2313 insertions(+), 4 deletions(-) create mode 100644 .cursorrules create mode 100644 ARCHITECTURE.md create mode 100644 DEVELOPMENT.md diff --git a/.cursorrules b/.cursorrules new file mode 100644 index 00000000..fc27ae53 --- /dev/null +++ b/.cursorrules @@ -0,0 +1,349 @@ +# CoreUI Free Vue Admin Template - AI Assistant Rules + +You are working with the CoreUI Free Vue Admin Template, a professional admin dashboard built with Vue 3, CoreUI Vue components, and modern build tools. This project uses Vite for development and building, Vue Router for navigation, Pinia for state management, and Sass for styling. + +## Critical Rules + +**Component Library**: ALWAYS use CoreUI Vue components from https://coreui.io/vue/docs/. NEVER use Tailwind CSS, Vuetify, Element Plus, or other component libraries. This project is built on Bootstrap 5 and CoreUI Vue components exclusively. + +**Technology Stack**: This project uses: +- Vue 3.5.x with Composition API and script setup +- Single File Components (SFC) with