- Backend: FastAPI app with all models, services, schemas, routes - Admin Panel: Next.js dashboard with all modules (CRM, POS, repairs, warranties, billing, notifications, etc.) - Ecommerce: storefront (submodule) + product catalog - AI Agents: .agents/ skill library for Antigravity IDE - Docs: architecture, billing, notification gateway markdown - Submodules: Backend/OpenWA, Ecommerce/File 2/storefront
21 lines
1 KiB
Markdown
21 lines
1 KiB
Markdown
---
|
|
name: "Documentation Drift"
|
|
description: "Compares current code structures against markdown files in docs/ and reports discrepancies."
|
|
---
|
|
|
|
# Skill: Documentation Drift
|
|
|
|
## 1. Purpose
|
|
Identify and flag outdated documentation, ensuring schema, code signatures, and markdown specs match 100%.
|
|
|
|
## 2. When to Use
|
|
Run after code modifications are finished and documentation has been updated.
|
|
|
|
## 3. Step-by-Step Checklist
|
|
1. Compare current code features against markdown specs:
|
|
- **Endpoints**: Cross-reference actual FastAPI routers (e.g. `GET /api/v1/customers`) with `/docs/api/`.
|
|
- **Database Tables**: Compare actual columns in SQLAlchemy models with `/docs/database/`.
|
|
- **Parameters/JSON Responses**: Check schema fields against example payloads in documentation.
|
|
- **Components**: Verify React component signatures match `/docs/frontend/`.
|
|
2. Check for missing columns, outdated environments, or obsolete business logic descriptions.
|
|
3. If discrepancies are found, report a "Documentation Outdated" warning and update the docs immediately.
|