mirror of
https://github.com/usememos/memos.git
synced 2026-11-19 10:29:11 +01:00
1.4 KiB
1.4 KiB
Design Documents
A design document records a decision and the reasoning behind it. Source code, tests, and package README.md or doc.go files describe current
behavior; a design document does not have to.
Lifecycle
- Draft. A design that is not yet shipped in a tagged release may change freely, even after its code is merged. Keep it in step with the implementation until the release, because the design itself often changes while a feature settles.
- Implemented. Once the feature ships in a release, set
Status: Implementedand freeze the body. Do not edit it to track later code changes. - Amendments. When a later release changes a frozen design, add or extend a dated
## Amendmentssection at the end that states what changed and why. Leave the original body intact, so the original rationale stays readable. A change large enough to need its own rationale gets a new design document that links back to the one it replaces.
Index
Drafts, merged but not yet released:
Implemented and frozen:
- API abuse controls
- Configuration provisioning, moved here from
docs/configuration-provisioning.mdafter implementation - Memos Export Format, including the schemas under
memo-export/1.0/ - Multi-Spaces
- Unique email