docs: Consolidate documentation - 41% reduction #29
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Contributor
Author
|
Contributor
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs | 87f6585 | Commit Preview URL Branch Preview URL |
Feb 10 2026, 03:46 PM |
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Consolidates documentation to eliminate duplication and bloat.
Reduction: 1062 lines → 648 lines (39% reduction)
Changes
1. ColdStarter (42% reduction)
2. Scrolls (18% reduction)
3. DruidUI Packages (75% reduction!)
Benefits
✅ No duplicate information
✅ No stale data
✅ Single source of truth
✅ Easier to maintain
✅ Less overwhelming
✅ All builds passing