29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
# Code Review: Docs & Design Artifacts
|
|
|
|
## Scope
|
|
- `docs/`
|
|
- `README.md`
|
|
- `WORKLOG.md`
|
|
|
|
## Findings
|
|
### ✅ Strengths
|
|
- Matrix-native design/intent/approach/work docs are consistent and aligned with implementation.
|
|
- README includes Matrix-native configuration, health endpoint, and E2EE limitation.
|
|
- Work log captures recent operational issues and next steps.
|
|
|
|
### ⚠️ Issues / Opportunities
|
|
1. **README still frames Matterbridge as core architecture**
|
|
- Architecture section says it is designed to work as a Matterbridge sidecar; Matrix-native mode is now an equal option.
|
|
- Consider reframing to describe two supported modes to avoid confusion.
|
|
|
|
2. **Worklog mentions Go 1.22.8**
|
|
- `WORKLOG.md` references Go 1.22.8; repo now uses Go 1.24.0.
|
|
- Consider updating the worklog or adding a note about the bump.
|
|
|
|
3. **No migration guide for Matrix-native**
|
|
- Docs include config, but no step-by-step migration/cutover guidance for Matterbridge deployments.
|
|
- Consider adding a short “migration” section covering shadow mode validation and cutover.
|
|
|
|
## Notes
|
|
- Design doc open questions are mostly resolved (SDK choice, state store). Might update the design doc to close them.
|