11 lines
434 B
Markdown
11 lines
434 B
Markdown
|
# Documentation
|
||
|
|
|
||
|
|
| Document | Purpose |
|
||
|
|
|----------|---------|
|
||
|
|
| [docs-as-code.md](docs-as-code.md) | How documentation is written, reviewed and checked |
|
||
|
|
| [adr/](adr/README.md) | Architecture Decision Records, one per feature |
|
||
|
|
|
||
|
|
Related, at the repository root: [README](../README.md), [USERGUIDE](../USERGUIDE.md),
|
||
|
|
[SECURITY](../SECURITY.md), [CHANGELOG](../CHANGELOG.md).
|
||
|
|
|
||
|
|
Check the docs before committing: `./docs/check-docs.sh`
|