Commit Graph

6 Commits

Author SHA1 Message Date
Timothy DeHerrera
f357ecd551 docs: add deployment guide
Create deployment.md how-to page covering local preview,
GitHub Pages, Netlify, Cloudflare Pages, and generic static
hosts. Add cross-links from homepage and getting-started
Next Steps. Reference security.md for CSP headers.
2026-02-12 13:20:41 -07:00
Timothy DeHerrera
f40233cb6e docs: add frontmatter defaults and enrich theming
Update Tera link to canonical URL, add authoring syntax
pointer. Add Default column to frontmatter fields table
with source-verified values. Enrich Theme System section
with core CSS variables table and customization pattern.
2026-02-12 13:10:22 -07:00
Timothy DeHerrera
bdf8976378 docs: rewrite homepage and consolidate sections
Rewrite _index.md as explanation-only — remove inline Quick
Start, add Learn More links. Move section discovery explanation
from features/sections.md into content-organization.md. Slim
sections.md to reference-only with cross-reference.
2026-02-12 13:04:07 -07:00
Timothy DeHerrera
73329aff81 docs: normalize terminology and fix metadata
Normalize "Sukr" to "sukr" in architecture.md (4 instances).
Change site.toml title to lowercase. Fix template override
path from page/special.html to content/special.html. Update
copyright year to 2026.
2026-02-12 12:57:07 -07:00
Timothy DeHerrera
ce830767ff docs: fix tutorial path with inline templates
Replace stale `cargo install sukr` with install-from-source.
Replace Step 4 dead-end with inline base.html, page.html,
and content/default.html templates. Add "View your site"
completion step. Improve Next Steps with reading-order context.
2026-02-12 12:45:09 -07:00
Timothy DeHerrera
978ae679ff docs(plan): add documentation overhaul plan
Exhaustive audit of the docs site identified 6 stale content items,
8 structural axiom violations, and 3 content gaps. This plan proposes
a 4-phase approach in dependency order:

Phase 1: Fix stale content (install commands, template paths, terminology)
Phase 2: Structural rework (quadrant discipline, section consolidation)
Phase 3: Fill content gaps (deployment guide, theming section)
Phase 4: README restructure + cross-references

Key decisions:
- Theming added to syntax-highlighting.md (avoids sync with themes/README)
- Deployment guide kept generic (suckless: no platform configs)
- Tutorial templates inlined (scope economy over starter repo)
- CLI and error reference deferred/cut (scope economy)
- sections.md slimmed to reference-only (quadrant split)

Sketch: .sketches/2026-02-11-documentation-improvements.md
2026-02-12 11:10:11 -07:00