AI Agents Guide
This guide helps AI coding assistants understand and use the CMS documentation system.
Overview
This CMS has specialized documentation for AI agents located in the.context/ directory.
Documentation Structure
For AI Agents
The.context/ directory contains:
Global Docs
System-wide architecture and specs
API Docs
Symfony API documentation
Front-Office
Nuxt 3 documentation
Back-Office
Vue 3 admin documentation
How to Use .context/
Reading Documentation
- Start with:
.context/global/architecture.md - Find specifics: Navigate to component directories
- Check features: Look in
.context/features/ - Use templates: From
.context/templates/
When to Update
Update.context/ when:
- Creating/modifying entities
- Adding/changing API endpoints
- Changing serialization groups
- Modifying multi-tenancy
- Updating workflows
- Adding features
- Deprecating features
Key Files for AI Agents
.context/global/architecture.md
.context/global/architecture.md
Complete system architecture overview
.context/global/api-contracts.md
.context/global/api-contracts.md
Master list of all API endpoints
.context/global/data-models.md
.context/global/data-models.md
All Doctrine entities and relationships
.context/global/serialization-groups.md
.context/global/serialization-groups.md
API Platform serialization groups
.context/global/workflows.md
.context/global/workflows.md
Editorial workflow specifications
.context/global/multi-tenancy.md
.context/global/multi-tenancy.md
Multi-tenant implementation details
Cursor Rules
The project includes.cursorrules with:
- Language rules (English only for code)
- Documentation update rules
- API contract standards
- Entity documentation standards
- Testing requirements
- Archiving procedures
Type Generation
TypeScript types are auto-generated from OpenAPI:.context/global/shared-types.ts.
Related Pages
Context Files
Detailed guide to .context/ structure
Coding Standards
Standards and conventions
Cursorrules Guide
Understanding .cursorrules
Type Generation
Auto-generated types
TODO
- Add detailed examples
- Add common patterns
- Add troubleshooting
- Add best practices