Docs

CONDITIONAL READ:

• Target Code: The source code files to be documented (Controllers, Entities, UseCases, etc.)
• Target Doc: The documentation file to be created or updated

Phase 2: Analysis & Extraction

Goal: Extract information from code

Actions:

• Entity Analysis: Extract fields, types, relationships, constraints from Entity classes
• Feature Analysis: Reverse-engineer business logic, API endpoints, and data flow from Controller/UseCase/Service

Phase 3: Documentation

Goal: Create or update documentation

Scenario A: Update Domain Model (/docs entity)

When: User wants to update entity documentation

Input: Entity class files (e.g., Booth.kt, BoothStats.kt)

Output: Update references/data-model/domains/{domain}/{Entity}.yaml

Process:

1. Read entity class files using Glob: src/**/entities/{EntityName}.kt
2. Extract structure:
   • Fields and types
   • Relationships (@ManyToOne, @OneToMany, etc.)
   • Constraints (@NotNull, @Size, etc.)
   • Embedded types
3. Update or create YAML file following existing structure in references/data-model/
4. Validate YAML syntax

Example:

# references/data-model/domains/booth/Booth.yaml