Initial skeleton: README.md
This commit is contained in:
@@ -1,3 +1,50 @@
|
||||
# daystrom-docs
|
||||
# Daystrom Institute — Documentation Repository
|
||||
|
||||
Daystrom Institute documentation — runbooks, host profiles, service configs
|
||||
> **daystrom-docs** is the canonical knowledge base for the Daystrom Institute's infrastructure, services, agents, and operational procedures.
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
This repository serves as the single source of truth for:
|
||||
|
||||
- **Host profiles** — per-device inventory, roles, and configuration notes
|
||||
- **Service documentation** — deployment configs, runbooks, and dependency maps
|
||||
- **Agent profiles** — autonomous agent access scopes, capabilities, and operational boundaries
|
||||
- **Infrastructure topology** — network layout, DNS, storage, and Docker Swarm configuration
|
||||
- **Runbooks** — step-by-step operational procedures for common and emergency scenarios
|
||||
|
||||
---
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
daystrom-docs/
|
||||
├── README.md ← You are here
|
||||
├── hosts/
|
||||
│ └── README.md ← Host inventory index
|
||||
├── services/
|
||||
│ └── README.md ← Service catalog index
|
||||
├── agents/
|
||||
│ ├── README.md ← Agent profiles index
|
||||
│ └── agent47/
|
||||
│ └── README.md ← Agent 47 access profiles
|
||||
├── infrastructure/
|
||||
│ └── README.md ← Network, DNS, storage, Swarm topology
|
||||
└── runbooks/
|
||||
└── README.md ← Operational procedures index
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
1. **Branch** off `main` for all changes (`docs/<topic>`).
|
||||
2. Keep entries factual and concise — no speculative content.
|
||||
3. Use placeholder markers (`<!-- TODO -->` or `_placeholder_`) for incomplete entries.
|
||||
4. Open a pull request and assign to the Daystrom documentation team for review.
|
||||
5. Runbooks must be tested before merge; note the test date in the document footer.
|
||||
|
||||
---
|
||||
|
||||
*Maintained by the Daystrom Institute infrastructure team.*
|
||||
|
||||
Reference in New Issue
Block a user