upleb.uk

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

summaryrefslogtreecommitdiff
path: root/docs/learnings
diff options
context:
space:
mode:
authorDanConwayDev <DanConwayDev@protonmail.com>2025-11-04 10:25:53 +0000
committerDanConwayDev <DanConwayDev@protonmail.com>2025-11-04 10:25:53 +0000
commit52bad9954cdddf55ab749fd0c6387edbc766632f (patch)
treed9dd2078b70a627a71d1adb9555cee83faec5cd0 /docs/learnings
parentdb460efdd4cf34d3b6ac8c19b1b8f89f22bc279f (diff)
docs: use Diátaxis structure
Diffstat (limited to 'docs/learnings')
-rw-r--r--docs/learnings/README.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/docs/learnings/README.md b/docs/learnings/README.md
new file mode 100644
index 0000000..ccd0c83
--- /dev/null
+++ b/docs/learnings/README.md
@@ -0,0 +1,69 @@
1# Learnings Directory - DEPRECATED
2
3**Status:** This directory is deprecated as of November 4, 2025.
4
5---
6
7## What Happened?
8
9We migrated to the **[Diátaxis](https://diataxis.fr/) documentation framework**, which provides a clearer structure based on content purpose rather than origin.
10
11---
12
13## Where Did Content Go?
14
15The "learnings" were distributed into appropriate Diátaxis categories:
16
17### Gotchas and Patterns → How-To Guides
18- `nix-flakes.md` → [`docs/how-to/nix-flakes.md`](../how-to/nix-flakes.md)
19- Task-oriented solutions to common problems
20
21### Technical Details → Reference
22- `nostr-sdk.md` → [`docs/reference/nostr-sdk-upgrade.md`](../reference/nostr-sdk-upgrade.md) (planned)
23- `git-http-backend.md` → [`docs/reference/git-protocol.md`](../reference/git-protocol.md)
24- Factual technical information
25
26### Concepts and Understanding → Explanation
27- `grasp-audit.md` → Incorporated into [`docs/explanation/architecture.md`](../explanation/architecture.md)
28- Discussion of design and architecture
29
30---
31
32## Why the Change?
33
34The "learnings" category was ambiguous:
35- Mixed gotchas, patterns, and concepts
36- Unclear where to put new content
37- Hard for readers to know what to expect
38
39**Diátaxis provides clear categories:**
40- **Tutorials** - Learning by doing
41- **How-To** - Solving problems
42- **Reference** - Looking up facts
43- **Explanation** - Understanding concepts
44
45See [`docs/README.md`](../README.md) for the new structure.
46
47---
48
49## For Content Authors
50
51**Don't create new files here.** Instead, ask:
52
53- "Can you teach me to...?" → [`docs/tutorials/`](../tutorials/)
54- "How do I...?" → [`docs/how-to/`](../how-to/)
55- "What is...?" → [`docs/reference/`](../reference/)
56- "Why...?" → [`docs/explanation/`](../explanation/)
57
58---
59
60## Migration Status
61
62- ✅ `nix-flakes.md` → Migrated to `how-to/nix-flakes.md`
63- ⏳ `nostr-sdk.md` → Being incorporated into reference docs
64- ✅ `grasp-audit.md` → Content in `explanation/architecture.md`
65
66---
67
68*This directory will be removed in a future cleanup.*
69*See [AGENTS.md](../../AGENTS.md) for documentation guidelines.*