Documentation Sync
Intent
Automatically triggered or manually requested to verify that the README.md, docs/, and OPENAPI specs match the current codebase.
Checklist
- README Consistency: Check if the "Getting Started" or "Architecture" sections in
README.mdare still accurate after recent changes. - API Alignment: Verify that FastAPI routes in
backend/main.pymatch descriptions indocs/API.md(if exists). - Plan Updates: If a task in
plan/is completed, ensure the implementation details are reflected in the final documentation. - Environment Variables: Check if new
.envvariables have been added toREADME.mdor.env.example.
Output Format
Documentation Status
- Files Checked: list of files
- Sync Issues:
- [File]: [What is missing or outdated]
- Suggested Updates:
- [Snippet of updated documentation]
