33 lines
1.2 KiB
Text
33 lines
1.2 KiB
Text
---
|
|
description: Reminder to update wiki documentation when making conceptual or structural code changes
|
|
alwaysApply: true
|
|
---
|
|
|
|
# Documentation Sync
|
|
|
|
When a code change touches any of these areas, remind the user to update the wiki:
|
|
|
|
- Public API endpoints (new/changed/removed routes)
|
|
- Domain logic flow (how data moves through services)
|
|
- Security boundaries (neutralization, auth, encryption)
|
|
- RBAC model (roles, permissions, access rules)
|
|
- Navigation / routing structure
|
|
- Feature boundaries (new feature module, moved responsibilities)
|
|
- Billing / subscription logic
|
|
- UI text changes (all visible UI strings must use `t()` for i18n -- see `wiki/d-guides/coding-conventions.md`)
|
|
|
|
## During active work
|
|
|
|
Update the working document in `wiki/c-work/<phase>/<feature>.md` (Kanban: 1-plan → 2-build → 3-validate → 4-done).
|
|
|
|
## When work is done (merged/released)
|
|
|
|
- Update the affected canonical page in `wiki/b-reference/`
|
|
- Set `lastReviewed` and `verifiedAgainst` in the page header
|
|
- Check if `wiki/TOPICS.md` needs a new or changed entry
|
|
|
|
## Skip documentation for
|
|
|
|
- Pure refactors without behavior change
|
|
- Formatting, linting, dependency bumps
|
|
- Test-only changes
|