Add /docs dir(s?), begin writing (light) documentation
Open
cross-cutting
documentation
- Dominant language
- TypeScript
- Stars
- 3
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
Probably a root-level `/doc`s dir for cross-cutting documentation and architecture diagrams, maybe `/{service}/docs` dirs for service specific docs as well, although to start the service level READMEs could be sufficient.
Preferably we just document architecture, APIs, and development requirements. Generally, the code should be "self-documenting".
We should start maintaining architecture diagrams in the root docs dir, probably made with d2.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.