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.
This commit is contained in:
Timothy DeHerrera
2026-02-12 12:57:07 -07:00
parent ce830767ff
commit 73329aff81
5 changed files with 11 additions and 11 deletions

View File

@@ -5,7 +5,7 @@ weight: 5
toc: true
---
Sukr is a 13-module static site compiler. Every feature that would typically require client-side JavaScript is moved to build-time.
sukr is a 13-module static site compiler. Every feature that would typically require client-side JavaScript is moved to build-time.
## Pipeline Overview
@@ -68,7 +68,7 @@ This pattern avoids buffering the entire document. Each code block is processed
Traditional SSGs ship JavaScript for:
| Feature | Typical Approach | Sukr Approach |
| Feature | Typical Approach | sukr Approach |
| :------------------ | :--------------------- | :------------------------------------------------ |
| Syntax highlighting | Prism.js, Highlight.js | Tree-sitter at build-time → `<span class="hl-*">` |
| Math rendering | MathJax, KaTeX.js | KaTeX at build-time → MathML (browser-native) |
@@ -79,7 +79,7 @@ The result: **zero bytes of JavaScript** in the output. Pages load instantly, wo
## Static Configuration Pattern
Tree-sitter grammars are expensive to initialize. Sukr uses [tree-house](https://github.com/helix-editor/tree-house) (Helix editor's Tree-sitter integration) with `LazyLock` to create language configurations exactly once:
Tree-sitter grammars are expensive to initialize. sukr uses [tree-house](https://github.com/helix-editor/tree-house) (Helix editor's Tree-sitter integration) with `LazyLock` to create language configurations exactly once:
```rust
/// Create a LanguageConfig for a language with embedded queries.
@@ -121,7 +121,7 @@ This avoids repeated directory scans during template rendering.
## Implementation Notes
Sukr prioritizes **output quality** over minimal build-time footprint. Current dependency choices reflect this:
sukr prioritizes **output quality** over minimal build-time footprint. Current dependency choices reflect this:
| Feature | Library | Trade-off |
| :------- | :--------- | :----------------------------------------------------------------------- |

View File

@@ -102,4 +102,4 @@ template: special
---
```
This uses `templates/page/special.html` instead of the default.
This uses `templates/content/special.html` instead of the default.

View File

@@ -63,10 +63,10 @@ None. All CHALLENGE questions resolved.
1. **Phase 1: Fix Stale Content** — every factual claim matches reality
- [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)
- [x] S5: Normalize "Sukr" → "sukr" in `architecture.md`
- [x] S6: Normalize `title` in `docs/site.toml`
- [x] S7: Fix template override path in `templates.md` (`page/special.html``content/special.html`)
- [x] S9: Update copyright in `docs/templates/base.html` (2024 → 2026, or remove if unnecessary for OSS)
- [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

View File

@@ -1,6 +1,6 @@
author = "Sukr Contributors"
base_url = "https://sukr.io"
title = "Sukr Documentation"
title = "sukr documentation"
[paths]
content = "content"

View File

@@ -58,7 +58,7 @@
</nav>
<footer class="sidebar-footer">
<a href="https://github.com/nrdxp/sukr">GitHub</a>
<span>© 2024 nrdxp — MIT</span>
<span>© 2026 nrdxp — MIT</span>
</footer>
</aside>
<main>{% block content %}{% endblock content %}</main>