Skip to content

Commit 3f88945

Browse files
committed
Docs: Add PR documentation for docs suite
1 parent a18b003 commit 3f88945

1 file changed

Lines changed: 117 additions & 0 deletions

File tree

PR-DOCUMENTATION.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
# Documentation PR
2+
3+
## Branch
4+
`security/audit-fixes-2026-03-01`
5+
6+
## Summary
7+
Comprehensive documentation suite following Edictum core style.
8+
9+
---
10+
11+
## Documentation Structure
12+
13+
```
14+
docs/
15+
├── index.md # Home page
16+
├── quickstart.md # 5-minute setup guide
17+
├── concepts/
18+
│ ├── architecture.md # System design
19+
│ ├── multi-tenancy.md # Tenant isolation
20+
│ ├── authentication.md # Auth flows
21+
│ ├── event-pipeline.md # Event flow
22+
│ └── approvals.md # HITL workflows
23+
├── guides/
24+
│ ├── docker.md # Docker deployment
25+
│ ├── connect-agent.md # Agent connection
26+
│ ├── notifications.md # Alert setup
27+
│ ├── deploy-contracts.md # Contract management
28+
│ └── api-keys.md # Key management
29+
├── reference/
30+
│ ├── api.md # API endpoints
31+
│ ├── configuration.md # Environment vars
32+
│ ├── channels.md # Notification channels
33+
│ └── security.md # Security reference
34+
└── deploy/
35+
├── production.md # Production checklist
36+
├── env-vars.md # Quick env reference
37+
├── database.md # Database setup
38+
└── troubleshooting.md # Common issues
39+
```
40+
41+
---
42+
43+
## MkDocs Configuration
44+
45+
```yaml
46+
# mkdocs.yml
47+
site_name: Edictum Console
48+
site_url: https://docs.edictum.dev/console/
49+
theme:
50+
name: material
51+
palette:
52+
- scheme: default
53+
primary: deep purple
54+
```
55+
56+
---
57+
58+
## Style Guide Compliance
59+
60+
Following Edictum's `.docs-style-guide.md`:
61+
62+
✅ Problem-first framing ("Agents do Y bad thing. Edictum prevents this by...")
63+
✅ Copy-pasteable code examples
64+
✅ No marketing language
65+
✅ Short paragraphs (2-3 sentences)
66+
✅ Deterministic language
67+
68+
---
69+
70+
## Coverage
71+
72+
| Feature | Documentation |
73+
|---------|---------------|
74+
| Authentication | ✅ concepts/authentication.md |
75+
| API Keys | ✅ guides/api-keys.md |
76+
| Contracts | ✅ guides/deploy-contracts.md |
77+
| Events | ✅ concepts/event-pipeline.md |
78+
| Approvals | ✅ concepts/approvals.md |
79+
| Notifications | ✅ guides/notifications.md |
80+
| Docker | ✅ guides/docker.md |
81+
| Security | ✅ reference/security.md |
82+
| API | ✅ reference/api.md |
83+
| Configuration | ✅ reference/configuration.md |
84+
| Troubleshooting | ✅ deploy/troubleshooting.md |
85+
86+
---
87+
88+
## Total
89+
90+
- 22 documentation pages
91+
- ~4,300 lines of documentation
92+
- Full feature coverage
93+
94+
---
95+
96+
## Build & Preview
97+
98+
```bash
99+
# Install MkDocs
100+
pip install mkdocs-material
101+
102+
# Preview locally
103+
mkdocs serve
104+
105+
# Build
106+
mkdocs build
107+
```
108+
109+
---
110+
111+
## Deployment
112+
113+
Documentation can be deployed to:
114+
- GitHub Pages
115+
- Netlify
116+
- Vercel
117+
- Read the Docs

0 commit comments

Comments
 (0)