servius/sukr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: restructure README to explanation quadrant

Browse Source 
Remove duplicated comparison table, inline config reference,
and content structure diagram from README — link to docs site
instead. Trim themes/README.md to attribution and theme list,
link to syntax-highlighting docs for usage and customization.
This commit is contained in:
Timothy DeHerrera
2026-02-12 13:24:05 -07:00
parent f357ecd551
commit 44e51cbdb7
3 changed files with 20 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/plans/documentation-overhaul.md
View File

@@ -83,11 +83,11 @@ None. All CHALLENGE questions resolved.
- [x] Update `getting-started.md` "Next Steps" to include deployment
4. **Phase 4: README + Cross-references** — README serves as focused explanation, cross-links established
- [ ] Restructure `README.md` to explanation quadrant (what, why, how it compares)
- [ ] Remove duplicated comparison table (link to docs site `comparison.md`)
- [ ] Remove inline config reference (link to docs site `configuration.md`)
- [ ] Keep security overview (short, relevant for trust evaluation)
- [ ] Trim `themes/README.md` to attribution + structure + link to docs site (targeted exception)
- [x] Restructure `README.md` to explanation quadrant (what, why, how it compares)
- [x] Remove duplicated comparison table (link to docs site `comparison.md`)
- [x] Remove inline config reference (link to docs site `configuration.md`)
- [x] Keep security overview (short, relevant for trust evaluation)
- [x] Trim `themes/README.md` to attribution + structure + link to docs site (targeted exception)
- [ ] Add cross-references between docs pages where missing
## Verification