This commit is contained in:
@@ -1,17 +1,10 @@
|
||||
# infra-run/docs
|
||||
# docs
|
||||
|
||||
This directory is intended for supporting technical documentation tied to the operational tooling in `infra-run`. It is the natural home for implementation notes, architecture writeups, and operational reference material.
|
||||
Planned area for longer technical notes.
|
||||
|
||||
## Diagram
|
||||
Current documentation lives in the project README files plus:
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A["docs"] --> B["Architecture notes"]
|
||||
A --> C["Operational references"]
|
||||
A --> D["Change preparation notes"]
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- The folder currently contains only a placeholder file.
|
||||
- It complements `runbooks` by focusing on reference material rather than step-by-step execution flows.
|
||||
- [SOURCE.md](../SOURCE.md)
|
||||
- [TESTED.md](../TESTED.md)
|
||||
- [KNOWN_LIMITATIONS.md](../KNOWN_LIMITATIONS.md)
|
||||
- [ROADMAP.md](../ROADMAP.md)
|
||||
|
||||
Reference in New Issue
Block a user