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

  1. Start with: .context/global/architecture.md
  2. Find specifics: Navigate to component directories
  3. Check features: Look in .context/features/
  4. 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

Complete system architecture overview
Master list of all API endpoints
All Doctrine entities and relationships
API Platform serialization groups
Editorial workflow specifications
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:
./tools/generate-ts-types.sh
Types are stored in .context/global/shared-types.ts.
Never manually edit shared-types.ts - always regenerate from OpenAPI spec.

TODO

  • Add detailed examples
  • Add common patterns
  • Add troubleshooting
  • Add best practices