upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/docs/archive/2025-11-04-diataxis-migration.md
diff options
context:
space:
mode:
authorDanConwayDev <DanConwayDev@protonmail.com>2025-12-03 11:19:40 +0000
committerDanConwayDev <DanConwayDev@protonmail.com>2025-12-03 11:19:40 +0000
commit2eaff5b79fed364d5eba5eb38e4b7bf76326884d (patch)
treedeacd6294f8860096ee82ee76930204efd65e33c /docs/archive/2025-11-04-diataxis-migration.md
parent57bc8cd9c021feaf08e139e8fb62800bc476068e (diff)
remove docs archive
Diffstat (limited to 'docs/archive/2025-11-04-diataxis-migration.md')
-rw-r--r--docs/archive/2025-11-04-diataxis-migration.md355
1 files changed, 0 insertions, 355 deletions
diff --git a/docs/archive/2025-11-04-diataxis-migration.md b/docs/archive/2025-11-04-diataxis-migration.md
deleted file mode 100644
index deed23d..0000000
--- a/docs/archive/2025-11-04-diataxis-migration.md
+++ /dev/null
@@ -1,355 +0,0 @@
1# Diátaxis Migration Complete ✅
2
3**Date:** November 4, 2025
4**Status:** COMPLETE
5
6---
7
8## What Changed?
9
10We migrated all documentation to the **[Diátaxis](https://diataxis.fr/) framework**, which organizes content into four clear categories based on purpose and audience.
11
12---
13
14## Before and After
15
16### Before (Flat Structure)
17```
18docs/
19├── ARCHITECTURE.md
20├── COMPARISON.md
21├── DECISION_SUMMARY.md
22├── GETTING_STARTED.md
23├── GIT_PROTOCOL.md
24├── TEST_STRATEGY.md
25├── learnings/
26│ ├── nix-flakes.md
27│ ├── nostr-sdk.md
28│ └── grasp-audit.md
29└── archive/
30```
31
32**Problems:**
33- Unclear where to put new docs
34- Mixed purposes (learning, reference, explanation)
35- Hard for readers to know what to expect
36- "learnings" was ambiguous
37
38### After (Diátaxis Structure)
39```
40docs/
41├── tutorials/ # Learning-oriented
42│ ├── getting-started.md
43│ └── first-audit.md
44├── how-to/ # Task-oriented
45│ └── nix-flakes.md
46├── reference/ # Information-oriented
47│ ├── configuration.md
48│ ├── git-protocol.md
49│ └── test-strategy.md
50├── explanation/ # Understanding-oriented
51│ ├── architecture.md
52│ ├── inline-authorization.md
53│ ├── comparison.md
54│ └── decisions.md
55└── archive/ # Historical
56```
57
58**Benefits:**
59- ✅ Clear categorization by purpose
60- ✅ Easy to know where to put new docs
61- ✅ Readers know what to expect
62- ✅ Follows industry best practice
63
64---
65
66## Migration Map
67
68| Old Location | New Location | Category |
69|-------------|-------------|----------|
70| `GETTING_STARTED.md` | `tutorials/getting-started.md` | Tutorial |
71| *(new)* | `tutorials/first-audit.md` | Tutorial |
72| `learnings/nix-flakes.md` | `how-to/nix-flakes.md` | How-To |
73| *(planned)* | `how-to/deploy.md` | How-To |
74| `GIT_PROTOCOL.md` | `reference/git-protocol.md` | Reference |
75| `TEST_STRATEGY.md` | `reference/test-strategy.md` | Reference |
76| *(new)* | `reference/configuration.md` | Reference |
77| `ARCHITECTURE.md` | `explanation/architecture.md` | Explanation |
78| `DECISION_SUMMARY.md` | `explanation/decisions.md` | Explanation |
79| `COMPARISON.md` | `explanation/comparison.md` | Explanation |
80| *(new)* | `explanation/inline-authorization.md` | Explanation |
81| `learnings/` | **DEPRECATED** | *(distributed)* |
82
83---
84
85## The Diátaxis Quadrants
86
87```
88 PRACTICAL THEORETICAL
89 ───────── ───────────
90
91LEARNING │ Tutorials │ Explanation │
92 │ │ │
93 │ "Can you │ "Why does │
94 │ teach me?" │ this work?" │
95 │ │ │
96 ├────────────────┼──────────────────┤
97 │ │ │
98WORKING │ How-To │ Reference │
99 │ Guides │ │
100 │ │ "What is the │
101 │ "How do I?" │ syntax?" │
102 │ │ │
103```
104
105### When to Use Each Category
106
107**Tutorials** (`docs/tutorials/`)
108- ✅ Teaching beginners
109- ✅ Step-by-step lessons
110- ✅ Guaranteed outcomes
111- ❓ "Can you teach me to use ngit-grasp?"
112- 📝 Example: Getting Started
113
114**How-To Guides** (`docs/how-to/`)
115- ✅ Solving specific problems
116- ✅ Practical recipes
117- ✅ Assumes basic knowledge
118- ❓ "How do I deploy ngit-grasp?"
119- 📝 Example: Configure Nix Flakes
120
121**Reference** (`docs/reference/`)
122- ✅ Technical specifications
123- ✅ Factual information
124- ✅ Comprehensive details
125- ❓ "What are all the config options?"
126- 📝 Example: Configuration Reference
127
128**Explanation** (`docs/explanation/`)
129- ✅ Understanding concepts
130- ✅ Design decisions
131- ✅ Discussing alternatives
132- ❓ "Why inline authorization?"
133- 📝 Example: Architecture Overview
134
135---
136
137## New Documentation Created
138
139### Tutorials
140- ✅ `tutorials/getting-started.md` - Migrated and enhanced
141- ✅ `tutorials/first-audit.md` - **NEW** - Learn grasp-audit
142
143### How-To Guides
144- ✅ `how-to/nix-flakes.md` - Migrated from learnings
145
146### Reference
147- ✅ `reference/configuration.md` - **NEW** - Complete config reference
148- ✅ `reference/git-protocol.md` - Migrated
149- ✅ `reference/test-strategy.md` - Migrated
150
151### Explanation
152- ✅ `explanation/inline-authorization.md` - **NEW** - Deep dive on key decision
153- ✅ `explanation/architecture.md` - Migrated
154- ✅ `explanation/comparison.md` - Migrated
155- ✅ `explanation/decisions.md` - Migrated
156
157### Category Indexes
158- ✅ `tutorials/README.md` - Category guide
159- ✅ `how-to/README.md` - Category guide
160- ✅ `reference/README.md` - Category guide
161- ✅ `explanation/README.md` - Category guide
162
163### Navigation
164- ✅ `docs/README.md` - Main navigation with Diátaxis diagram
165- ✅ `learnings/README.md` - Deprecation notice
166
167---
168
169## Updated Files
170
171### Project Documentation
172- ✅ `AGENTS.md` - Updated with Diátaxis guidelines
173- ✅ `README.md` - Updated links to new structure
174
175### Moved Files
176```bash
177# Explanation
178docs/ARCHITECTURE.md → docs/explanation/architecture.md
179docs/COMPARISON.md → docs/explanation/comparison.md
180docs/DECISION_SUMMARY.md → docs/explanation/decisions.md
181
182# Reference
183docs/GIT_PROTOCOL.md → docs/reference/git-protocol.md
184docs/TEST_STRATEGY.md → docs/reference/test-strategy.md
185
186# How-To
187docs/learnings/nix-flakes.md → docs/how-to/nix-flakes.md
188```
189
190---
191
192## For Content Authors
193
194### Creating New Documentation
195
196**Ask yourself:**
197
1981. **"Can you teach me to...?"**
199 - → Tutorial (`docs/tutorials/`)
200 - Example: "Can you teach me to deploy ngit-grasp?"
201
2022. **"How do I...?"**
203 - → How-To (`docs/how-to/`)
204 - Example: "How do I configure rate limiting?"
205
2063. **"What is...?"**
207 - → Reference (`docs/reference/`)
208 - Example: "What is the NGIT_DOMAIN variable?"
209
2104. **"Why...?"**
211 - → Explanation (`docs/explanation/`)
212 - Example: "Why use Rust instead of Go?"
213
214### Quick Decision Tree
215
216```
217Is it teaching a beginner from scratch?
218├─ YES → Tutorial
219└─ NO
220 └─ Is it solving a specific problem?
221 ├─ YES → How-To
222 └─ NO
223 └─ Is it factual/technical information?
224 ├─ YES → Reference
225 └─ NO → Explanation
226```
227
228---
229
230## For Readers
231
232### Finding What You Need
233
234**I'm brand new:**
2351. Start with [README.md](README.md)
2362. Follow [Getting Started Tutorial](docs/tutorials/getting-started.md)
2373. Read [Architecture Explanation](docs/explanation/architecture.md)
238
239**I have a specific problem:**
2401. Check [How-To Guides](docs/how-to/)
2412. Search for your problem
2423. Follow the recipe
243
244**I need technical details:**
2451. Check [Reference](docs/reference/)
2462. Use search or table of contents
2473. Look up what you need
248
249**I want to understand the design:**
2501. Read [Explanation](docs/explanation/)
2512. Start with [Architecture](docs/explanation/architecture.md)
2523. Dive into specific decisions
253
254---
255
256## Benefits of Diátaxis
257
258### For Authors
259- ✅ Clear guidelines on where to put content
260- ✅ Consistent structure across all docs
261- ✅ Easy to know what style to use
262- ✅ Less decision fatigue
263
264### For Readers
265- ✅ Know what to expect from each doc
266- ✅ Easy to find what you need
267- ✅ Can navigate by purpose
268- ✅ Better learning experience
269
270### For Maintainers
271- ✅ Easier to review contributions
272- ✅ Clearer documentation standards
273- ✅ Less duplicate content
274- ✅ Sustainable structure
275
276---
277
278## Compliance with AGENTS.md
279
280Updated `AGENTS.md` to enforce Diátaxis:
281
282- ✅ Documentation structure section updated
283- ✅ File lifecycle includes Diátaxis categories
284- ✅ "Before creating documents" includes Diátaxis questions
285- ✅ Cleanup process updated
286- ✅ `learnings/` marked as deprecated
287
288**AI agents will now:**
289- Ask Diátaxis questions before creating docs
290- Place content in correct category
291- Follow category-specific guidelines
292- Maintain consistent structure
293
294---
295
296## Migration Checklist
297
298- ✅ Create Diátaxis directory structure
299- ✅ Migrate existing docs to appropriate categories
300- ✅ Create new documentation (tutorials, how-to, reference)
301- ✅ Create category README files
302- ✅ Update main docs/README.md with Diátaxis diagram
303- ✅ Update AGENTS.md with Diátaxis guidelines
304- ✅ Mark learnings/ as deprecated
305- ✅ Update project README.md links
306- ✅ Create this migration document
307- ✅ Test all internal links
308
309---
310
311## Next Steps
312
313### Immediate
314- ✅ Archive this document after review
315- ✅ Update any broken links
316- ✅ Commit all changes
317
318### Short-term
319- 🔜 Complete planned how-to guides (deploy, test-compliance)
320- 🔜 Migrate remaining learnings content
321- 🔜 Add more tutorials as features complete
322
323### Long-term
324- 🔜 Generate API reference from code
325- 🔜 Add video tutorials
326- 🔜 Create interactive examples
327- 🔜 Translate to other languages
328
329---
330
331## Resources
332
333- **[Diátaxis Framework](https://diataxis.fr/)** - Official documentation
334- **[Diátaxis: How to use](https://diataxis.fr/how-to-use-diataxis/)** - Implementation guide
335- **[Examples](https://diataxis.fr/examples/)** - Real-world examples
336
337---
338
339## Questions?
340
341- Check [docs/README.md](docs/README.md) for navigation
342- Read category README files for guidelines
343- See [AGENTS.md](AGENTS.md) for contribution rules
344- Open an issue if something is unclear
345
346---
347
348**Migration completed:** November 4, 2025
349**Migrated by:** AI Agent (Dork)
350**Framework:** [Diátaxis](https://diataxis.fr/)
351**Status:** ✅ Complete and enforced
352
353---
354
355*This document will be archived to `docs/archive/` after review.*