Add TUI design guide and update contributing documentation
This commit is contained in:
parent
167a6596b2
commit
3ce7ba8d5c
3 changed files with 411 additions and 0 deletions
|
|
@ -41,6 +41,9 @@ Core code that is not reachable through the TUI is not yet a supported product
|
|||
feature. Do not advertise it in user-facing documentation until users can
|
||||
actually invoke it.
|
||||
|
||||
Read the [TUI design guide](docs/design-guide.md) before changing layouts,
|
||||
components, interaction states, user-visible copy, or terminal-size behavior.
|
||||
|
||||
## Domain language and decisions
|
||||
|
||||
Read [CONTEXT.md](CONTEXT.md) before naming user-visible concepts. Use its
|
||||
|
|
@ -111,6 +114,8 @@ Documentation is part of the behavior contract:
|
|||
persistence, recovery, configuration, or troubleshooting change.
|
||||
- Update [CONTEXT.md](CONTEXT.md) when the canonical domain language changes;
|
||||
keep it a glossary rather than an architecture guide or progress log.
|
||||
- Update the [TUI design guide](docs/design-guide.md) when an intentional UI
|
||||
pattern should become the new project-wide standard.
|
||||
- Update ADR 0002 and the README if serialization stops being normalized or
|
||||
becomes byte-preserving.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue