Artifact cafd3ab4f1098f6faa7640fbe88344cbd9e5c991c1fba6320c398862b273b225:
- File
docs/site/hugo.yaml
— part of check-in
[f30849a466]
at
2026-04-26 14:14:53
on branch trunk
— docs: usability improvements from DX audit (#9)
Implements all seven recommended changes from the docs audit:
1. SDK pages now show package names in nav. Add scripts/prepend-sdk-frontmatter.sh that prepends '--- title: <pkg> ---' to each gomarkdoc-generated api.md; wired into 'make docs-gen-sdk'. Sidebar previously showed five undifferentiated 'API' entries; now shows cli, db, dst, libfossil, observer/otel.
2. /examples/ populated with paragraphs + GitHub deep-links for embed-repo-api and wasm. No longer a placeholder pointing back at the repo.
3. Architecture page gets an inline SVG mirroring the landing-page diagram. Self-contained CSS (uses currentColor + ember accent) so it tracks Hextra's light/dark theme without depending on the landing's CSS scope.
4. Cross-links added: quickstart -> production + extension-points, migration -> architecture, architecture -> extension-points. Extension Points and Production patterns are now reachable via prose, not just the sidebar.
5. /docs/ landing expanded from 3 sentences to a 7-line subsection map calling out each page's purpose.
6. Version indicator in navbar (libfossil v0.4.2). Override layouts/_partials/navbar-title.html mimics Hextra's default and appends a small mono version tag from .Site.Params.version.
7. New /docs/production/ page covering error handling, context cancellation, telemetry wiring, repo-handle lifetime, and driver selection — the patterns the quickstart's log.Fatal shortcuts gloss over. (user: [email protected], size: 1061) [annotate] [blame] [check-ins using]
title: libfossil baseURL: "https://libfossil-docs.daniel-mestas.workers.dev/" module: imports: - path: github.com/imfing/hextra markup: goldmark: renderer: unsafe: true highlight: noClasses: false menu: main: - name: Docs pageRef: /docs weight: 1 - name: SDK pageRef: /docs/reference/sdk weight: 2 - name: Examples pageRef: /examples weight: 3 - name: Search weight: 4 params: type: search - name: GitHub weight: 5 url: "https://github.com/danmestas/libfossil" params: icon: github params: version: "0.4.2" navbar: displayTitle: true displayLogo: false theme: default: system displayToggle: true search: enable: true type: flexsearch flexsearch: index: content tokenize: forward footer: displayCopyright: true displayPoweredBy: false editURL: enable: true base: "https://github.com/danmestas/libfossil/edit/main/docs/site/content" page: width: wide