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

docs: fix tutorial path with inline templates

Browse Source 
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.
This commit is contained in:
Timothy DeHerrera
2026-02-12 12:45:09 -07:00
parent 978ae679ff
commit ce830767ff
3 changed files with 60 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -61,13 +61,13 @@ None. All CHALLENGE questions resolved.
## Phases
1. **Phase 1: Fix Stale Content** — every factual claim matches reality
- [ ] S1: Replace `cargo install sukr` in `_index.md` with `cargo install --path .` after clone
- [ ] S4: Replace Step 4 dead-end in `getting-started.md` with inline minimal templates (base.html, page.html, content/default.html)
- [x] S1: Replace `cargo install sukr` in `_index.md` with `cargo install --path .` after clone
- [x] S4: Replace Step 4 dead-end in `getting-started.md` with inline minimal templates (base.html, page.html, content/default.html)
- [ ] S5: Normalize "Sukr" → "sukr" in `architecture.md`
- [ ] S6: Normalize `title` in `docs/site.toml`
- [ ] S7: Fix template override path in `templates.md` (`page/special.html` → `content/special.html`)
- [ ] S9: Update copyright in `docs/templates/base.html` (2024 → 2026, or remove if unnecessary for OSS)
- [ ] Add "view your site" final step to `getting-started.md` with expected output
- [x] Add "view your site" final step to `getting-started.md` with expected output
2. **Phase 2: Structural Rework** — every page declares one quadrant, serves one audience
- [ ] Rewrite `_index.md` as explanation quadrant (what sukr is, why it exists, link to tutorial)