blob: d6d54e2399572ec2057f2b6749fcf447754b08dc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
╔══════════════════════════════════════════════════════════════════════════════╗
║ DIÁTAXIS MIGRATION COMPLETE ✅ ║
║ November 4, 2025 ║
╚══════════════════════════════════════════════════════════════════════════════╝
┌──────────────────────────────────────────────────────────────────────────────┐
│ THE DIÁTAXIS FRAMEWORK │
└──────────────────────────────────────────────────────────────────────────────┘
PRACTICAL THEORETICAL
───────── ───────────
LEARNING │ Tutorials │ Explanation │
│ │ │
│ Getting │ Architecture │
│ Started │ Inline Auth │
│ First Audit │ Comparison │
│ │ Decisions │
│ │ │
├────────────────┼──────────────────┤
│ │ │
WORKING │ How-To │ Reference │
│ Guides │ │
│ │ Configuration │
│ Nix Flakes │ Git Protocol │
│ Deploy │ Test Strategy │
│ Testing │ GRASP Spec │
│ │ │
┌──────────────────────────────────────────────────────────────────────────────┐
│ DOCUMENTATION STRUCTURE │
└──────────────────────────────────────────────────────────────────────────────┘
docs/
├── README.md ..................... Main navigation with Diátaxis diagram
│
├── tutorials/ .................... 📚 Learning-oriented
│ ├── README.md ................. Category guide
│ ├── getting-started.md ........ ✅ First-time setup
│ └── first-audit.md ............ ✅ NEW: Learn grasp-audit
│
├── how-to/ ....................... 🔧 Task-oriented
│ ├── README.md ................. Category guide
│ ├── nix-flakes.md ............. ✅ Migrated from learnings/
│ ├── deploy.md ................. 🔜 Planned
│ ├── test-compliance.md ........ 🔜 Planned
│ └── upgrade-nostr-sdk.md ...... 🔜 Planned
│
├── reference/ .................... 📖 Information-oriented
│ ├── README.md ................. Category guide
│ ├── configuration.md .......... ✅ NEW: Complete config reference
│ ├── git-protocol.md ........... ✅ Migrated from docs/
│ ├── test-strategy.md .......... ✅ Migrated from docs/
│ ├── grasp-protocol.md ......... 🔜 Planned
│ └── api.md .................... 🔜 Planned
│
├── explanation/ .................. 💡 Understanding-oriented
│ ├── README.md ................. Category guide
│ ├── architecture.md ........... ✅ Migrated from docs/
│ ├── inline-authorization.md ... ✅ NEW: Deep dive on key decision
│ ├── comparison.md ............. ✅ Migrated from docs/
│ └── decisions.md .............. ✅ Migrated from docs/
│
├── archive/ ...................... 📦 Historical
│ └── YYYY-MM-DD-*.md ........... Session notes
│
└── learnings/ .................... ⚠️ DEPRECATED
└── README.md ................. Migration notice
┌──────────────────────────────────────────────────────────────────────────────┐
│ MIGRATION SUMMARY │
└──────────────────────────────────────────────────────────────────────────────┘
CREATED (New Documentation):
✅ docs/README.md ................. Main navigation with Diátaxis
✅ tutorials/getting-started.md ... Migrated + enhanced
✅ tutorials/first-audit.md ....... NEW: grasp-audit tutorial
✅ how-to/nix-flakes.md ........... Migrated from learnings/
✅ reference/configuration.md ..... NEW: Complete config reference
✅ explanation/inline-authorization.md . NEW: Deep dive
✅ tutorials/README.md ............ Category guide
✅ how-to/README.md ............... Category guide
✅ reference/README.md ............ Category guide
✅ explanation/README.md .......... Category guide
✅ learnings/README.md ............ Deprecation notice
MIGRATED (Moved to Diátaxis):
✅ ARCHITECTURE.md → explanation/architecture.md
✅ COMPARISON.md → explanation/comparison.md
✅ DECISION_SUMMARY.md → explanation/decisions.md
✅ GIT_PROTOCOL.md → reference/git-protocol.md
✅ TEST_STRATEGY.md → reference/test-strategy.md
✅ learnings/nix-flakes.md → how-to/nix-flakes.md
UPDATED (Enforcement):
✅ AGENTS.md ...................... Diátaxis guidelines
✅ README.md ...................... Links to new structure
✅ DIATAXIS_MIGRATION.md .......... This migration doc
┌──────────────────────────────────────────────────────────────────────────────┐
│ DECISION FRAMEWORK │
└──────────────────────────────────────────────────────────────────────────────┘
When creating new documentation, ask:
┌─────────────────────────────────────┐
│ "Can you teach me to...?" │ → TUTORIAL
│ │
│ Teaching from scratch │ docs/tutorials/
│ Step-by-step lesson │
│ Guaranteed outcome │
└─────────────────────────────────────┘
┌─────────────────────────────────────┐
│ "How do I...?" │ → HOW-TO
│ │
│ Solving specific problem │ docs/how-to/
│ Practical recipe │
│ Assumes basic knowledge │
└─────────────────────────────────────┘
┌─────────────────────────────────────┐
│ "What is...?" │ → REFERENCE
│ │
│ Technical specification │ docs/reference/
│ Factual information │
│ Comprehensive details │
└─────────────────────────────────────┘
┌─────────────────────────────────────┐
│ "Why...?" │ → EXPLANATION
│ │
│ Understanding concepts │ docs/explanation/
│ Design decisions │
│ Discussing alternatives │
└─────────────────────────────────────┘
┌──────────────────────────────────────────────────────────────────────────────┐
│ BENEFITS │
└──────────────────────────────────────────────────────────────────────────────┘
FOR AUTHORS:
✅ Clear guidelines on where to put content
✅ Consistent structure across all docs
✅ Easy to know what style to use
✅ Less decision fatigue
✅ Industry best practice
FOR READERS:
✅ Know what to expect from each doc
✅ Easy to find what you need
✅ Can navigate by purpose
✅ Better learning experience
✅ Clear reading paths
FOR MAINTAINERS:
✅ Easier to review contributions
✅ Clearer documentation standards
✅ Less duplicate content
✅ Sustainable structure
✅ Enforced by AGENTS.md
┌──────────────────────────────────────────────────────────────────────────────┐
│ QUICK REFERENCE │
└──────────────────────────────────────────────────────────────────────────────┘
NAVIGATION:
Start here ........... docs/README.md (Diátaxis diagram + paths)
For beginners ........ docs/tutorials/getting-started.md
For problems ......... docs/how-to/
For lookups .......... docs/reference/
For understanding .... docs/explanation/
GUIDELINES:
For AI agents ........ AGENTS.md (Diátaxis enforcement)
For contributors ..... Each category README.md
For migration ........ DIATAXIS_MIGRATION.md
EXTERNAL:
Framework ............ https://diataxis.fr/
Examples ............. https://diataxis.fr/examples/
┌──────────────────────────────────────────────────────────────────────────────┐
│ NEXT STEPS │
└──────────────────────────────────────────────────────────────────────────────┘
IMMEDIATE:
✅ Archive this visual summary to docs/archive/
✅ Archive DIATAXIS_MIGRATION.md after review
✅ Commit all changes
SHORT-TERM:
🔜 Complete planned how-to guides (deploy, test-compliance)
🔜 Migrate remaining learnings content
🔜 Add more tutorials as features complete
LONG-TERM:
🔜 Generate API reference from code
🔜 Add video tutorials
🔜 Create interactive examples
╔══════════════════════════════════════════════════════════════════════════════╗
║ ║
║ ✅ DIÁTAXIS MIGRATION COMPLETE ║
║ ║
║ Documentation now follows industry ║
║ best practice for technical writing ║
║ ║
║ https://diataxis.fr/ ║
║ ║
╚══════════════════════════════════════════════════════════════════════════════╝
|