Commit Graph

10 Commits

Author SHA1 Message Date
Timothy DeHerrera
021ffb6a78 docs(plan): add sukr 1.0 API stabilization plan
Three-phase plan to stabilize sukr's public API surfaces before 1.0:

- Phase 1: Replace hand-rolled YAML frontmatter with TOML (+++ delimiters,
  serde Deserialize), normalize template variable naming, add feed/sitemap
  config toggles, template section fallback, remove dead templates
- Phase 2: Draft filtering and alias redirect stub generation
- Phase 3: 404 page support and tag listing page generation

Key decisions: TOML frontmatter (eliminates fragile parser), config.nav
nesting to mirror site.toml structure, flat tags array, date validation
via chrono::NaiveDate.

Ref: .sketches/2026-02-13-api-stabilization.md
2026-02-14 06:24:56 -07:00
Timothy DeHerrera
8d213183f5 docs: complete verification and retrospective
Check off all 7 plan verification items with results.
Write retrospective covering what went well (phased approach,
source verification, CHALLENGE decisions), surprises (sketch
false positives, extra Sukr instances, existing Tera link),
process observations (CORE granularity, cross-phase deps,
tech debt tracking), and intentional deferrals (G2, G5,
security.md mixed quadrants).
2026-02-12 13:37:00 -07:00
Timothy DeHerrera
ef173ec092 docs: add cross-references and fix nav ordering
Link feature names in architecture.md to feature docs pages.
Add See Also section to configuration.md with related pages.
Add getting-started prerequisite link to deployment.md. Adjust
page weights for user journey sidebar order: Getting Started
(0) → Deployment (1) → Content Organization (2) → Config (3).
2026-02-12 13:27:23 -07:00
Timothy DeHerrera
44e51cbdb7 docs: restructure README to explanation quadrant
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.
2026-02-12 13:24:05 -07:00
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