Commit 645a2ce
docs: Consolidate documentation - 41% reduction (#29)
* docs: Consolidate documentation - reduce duplication and bloat
CONSOLIDATION SUMMARY:
- Reduced from 1062 lines to 631 lines (41% reduction)
- Eliminated duplicate information
- Single source of truth for all configs
CHANGES:
1. ColdStarter (94 → 47 lines, 50% cut)
- Made ultra-short overview
- Removed duplicate port configuration
- Links to Scrolls doc for full details
- Kept only essentials: what it is, basic example
2. Scrolls (294 → 217 lines, 26% cut)
- Added ColdStarter subsection with full port config
- Removed redundant scroll.yaml example (kept 2, removed 1)
- Removed '95 scrolls' game counts (will get stale)
- Simplified Nix explanation (removed verbose 'Why/How')
- Single source of truth for all scroll.yaml fields
3. DruidUI Packages (684 → 185 lines, 73% cut!)
- Consolidated 5 separate pages into 1 single page
- Each package: 15-20 lines with essentials
- Removed repetitive Installation/Usage/Options structure
- All 5 packages now in one easy-to-scan reference
4. DruidUI Intro (182 lines, unchanged)
- Fixed links to point to new packages.md
- Already concise, no changes needed
BENEFITS:
- No duplicate port configuration (was in 2 places)
- No stale game counts
- Easier to maintain (single source of truth)
- Less overwhelming for users
- Faster to scan and find info
All builds passing.
* docs: Fix scroll duplication in CLI section
PROBLEM:
- docs/cli/scroll.md had complete scroll.yaml documentation (118 lines)
- This duplicated EVERYTHING in docs/scrolls/introduction.md
- CLI intro.md also had redundant scroll explanations
SOLUTION:
1. CLI scroll.md (118 → 36 lines, 70% cut)
- Removed entire scroll.yaml format documentation
- Removed field descriptions
- Removed examples
- Now just: Quick reference + link to full docs
- Single source of truth: docs/scrolls/introduction.md
2. CLI intro.md (cleaned up)
- Simplified scroll mention to one line
- Changed link from /cli/scroll to ../scrolls/introduction.md
- Removed redundant explanations
RESULT:
- No more duplication between CLI and Scrolls sections
- Users directed to single authoritative scroll documentation
- CLI section now references, not duplicates
Build passing.
---------
Co-authored-by: Lugh (Druid Bot) <lugh@druid.gg>1 parent fabe5cb commit 645a2ce
12 files changed
Lines changed: 461 additions & 817 deletions
File tree
- docs
- cli
- druid-ui
- packages
- scrolls
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 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 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
17 | 17 | | |
18 | | - | |
19 | | - | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
| 18 | + | |
27 | 19 | | |
28 | 20 | | |
29 | 21 | | |
30 | | - | |
| 22 | + | |
31 | 23 | | |
32 | 24 | | |
33 | 25 | | |
34 | 26 | | |
35 | 27 | | |
36 | | - | |
37 | 28 | | |
38 | 29 | | |
39 | 30 | | |
40 | 31 | | |
41 | 32 | | |
42 | | - | |
43 | | - | |
44 | | - | |
45 | | - | |
46 | | - | |
47 | | - | |
| 33 | + | |
48 | 34 | | |
49 | 35 | | |
50 | 36 | | |
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 | | - | |
| 37 | + | |
81 | 38 | | |
82 | 39 | | |
83 | 40 | | |
84 | | - | |
85 | 41 | | |
86 | 42 | | |
87 | 43 | | |
88 | | - | |
89 | | - | |
90 | 44 | | |
91 | | - | |
| 45 | + | |
92 | 46 | | |
93 | 47 | | |
94 | 48 | | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | | - | |
15 | | - | |
| 14 | + | |
16 | 15 | | |
17 | 16 | | |
18 | 17 | | |
| |||
26 | 25 | | |
27 | 26 | | |
28 | 27 | | |
29 | | - | |
| 28 | + | |
30 | 29 | | |
31 | 30 | | |
32 | 31 | | |
| |||
0 commit comments