100 lines
2.5 KiB
Markdown
100 lines
2.5 KiB
Markdown
|
# Document Relationship Map
|
|||
|
|
|
|||
|
|
**Last Updated:** 2026-01-31
|
|||
|
|
**Document Version:** 1.0
|
|||
|
|
**Status:** Active Documentation
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## Overview
|
|||
|
|
|
|||
|
|
Optional high-level map of how key documentation links together. Use for onboarding and to avoid orphaned docs.
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## Relationship Diagram (Mermaid)
|
|||
|
|
|
|||
|
|
```mermaid
|
|||
|
|
flowchart TB
|
|||
|
|
subgraph entry["Entry points"]
|
|||
|
|
MASTER[MASTER_INDEX.md]
|
|||
|
|
DOCS_README[docs/README.md]
|
|||
|
|
SEARCH[SEARCH_GUIDE.md]
|
|||
|
|
end
|
|||
|
|
|
|||
|
|
subgraph categories["Category READMEs (02–12)"]
|
|||
|
|
A[02-architecture/README]
|
|||
|
|
B[03-deployment/README]
|
|||
|
|
C[04-configuration/README]
|
|||
|
|
D[05-network/README]
|
|||
|
|
E[09-troubleshooting/README]
|
|||
|
|
F[11-references/README]
|
|||
|
|
G[12-quick-reference/README]
|
|||
|
|
end
|
|||
|
|
|
|||
|
|
subgraph meta["00-meta"]
|
|||
|
|
STYLE[DOCUMENTATION_STYLE_GUIDE]
|
|||
|
|
TASKS[DOCUMENTATION_FIX_TASK_LIST]
|
|||
|
|
METRICS[DOCUMENTATION_METRICS]
|
|||
|
|
end
|
|||
|
|
|
|||
|
|
subgraph key["Key docs"]
|
|||
|
|
NET[NETWORK_ARCHITECTURE]
|
|||
|
|
VMID[VMID_ALLOCATION_FINAL]
|
|||
|
|
CLOUD[CLOUDFLARE_ROUTING_MASTER]
|
|||
|
|
RUN[OPERATIONAL_RUNBOOKS]
|
|||
|
|
FAQ[TROUBLESHOOTING_FAQ]
|
|||
|
|
CARDS[QUICK_REFERENCE_CARDS]
|
|||
|
|
end
|
|||
|
|
|
|||
|
|
MASTER --> A & B & C & D & E & F & G
|
|||
|
|
DOCS_README --> A & B & C
|
|||
|
|
SEARCH --> MASTER
|
|||
|
|
A --> NET & VMID
|
|||
|
|
D --> CLOUD
|
|||
|
|
B --> RUN
|
|||
|
|
E --> FAQ
|
|||
|
|
G --> CARDS
|
|||
|
|
STYLE --> TASKS & METRICS
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## ASCII Summary
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
MASTER_INDEX.md ──┬── 02-architecture/README ── NETWORK_ARCHITECTURE, VMID_ALLOCATION_FINAL
|
|||
|
|
├── 03-deployment/README ── OPERATIONAL_RUNBOOKS
|
|||
|
|
├── 04-configuration/README
|
|||
|
|
├── 05-network/README ── CLOUDFLARE_ROUTING_MASTER
|
|||
|
|
├── 09-troubleshooting/README ── TROUBLESHOOTING_FAQ
|
|||
|
|
├── 11-references/README ── NETWORK_CONFIGURATION_MASTER, GLOSSARY
|
|||
|
|
└── 12-quick-reference/README ── QUICK_REFERENCE_CARDS
|
|||
|
|
|
|||
|
|
00-meta/ ── DOCUMENTATION_STYLE_GUIDE ── DOCUMENTATION_FIX_TASK_LIST, DOCUMENTATION_METRICS
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## Optional: State Diagram Example (Container Lifecycle)
|
|||
|
|
|
|||
|
|
```mermaid
|
|||
|
|
stateDiagram-v2
|
|||
|
|
[*] --> created
|
|||
|
|
created --> running: start
|
|||
|
|
running --> stopped: stop
|
|||
|
|
stopped --> running: start
|
|||
|
|
running --> [*]: destroy
|
|||
|
|
stopped --> [*]: destroy
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
ASCII equivalent: `[created] --start--> [running] --stop--> [stopped] --start--> [running]`.
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## Related Documentation
|
|||
|
|
|
|||
|
|
- [MASTER_INDEX.md](../MASTER_INDEX.md) - Master documentation index
|
|||
|
|
- [DOCUMENTATION_STYLE_GUIDE.md](DOCUMENTATION_STYLE_GUIDE.md) - Standards and optional visuals
|
|||
|
|
- [docs/README.md](../README.md) - Docs overview
|