Skip to content

feat(docs): persistent sidebar + in-page TOC, consistent prev/next, corrected API references - #58

Merged
Bissbert merged 1 commit into
mainfrom
fix/docs-overhaul
Jul 16, 2026
Merged

feat(docs): persistent sidebar + in-page TOC, consistent prev/next, corrected API references#58
Bissbert merged 1 commit into
mainfrom
fix/docs-overhaul

Conversation

@Bissbert

Copy link
Copy Markdown
Contributor

Summary

  • Added a persistent grouped left sidebar to all 12 docs pages, driven by a single-source-of-truth nav.ts, with active-page highlight, sticky rail on desktop, and mobile disclosure.
  • Added an in-page TOC with scroll-spy on long reference pages (CDL spec, cli-options, components, 4 API pages) via a heading-scanning DocsTOC (desktop sticky rail + mobile bottom sheet).
  • Made PageNav prev/next consistent on every page in reading order (previously only on API pages).
  • Introduced DocsLayout wrapping every docs page.
  • Corrected API-doc drift against real package sources: crystal-renderer 1.0.1→2.0.0, mineral-database 2.2.0→2.3.0 + 140→216 presets + valid preset ids (quartz-prism/diamond-octahedron), crystal-geometry field rename + radians units + newly-documented public API, cdl-parser stale repr/type examples.
  • Reworked the CDL Examples page for the playground-disabled state (copy-to-clipboard per snippet, syntax-reference links into the spec, honest "coming back" callout), preserving the playground path to auto-restore when re-enabled.

Test plan

  • 502 tests passing
  • Both sticky rails measured pinned through deep scroll in light + dark
  • Browser-verified across docs pages

…orrected API references

- added a persistent grouped left sidebar to all 12 docs pages (nav.ts single source of truth, active-page highlight, sticky rail on desktop, mobile disclosure)
- in-page TOC with scroll-spy on long reference pages (CDL spec, cli-options, components, 4 API pages) via a heading-scanning DocsTOC (desktop sticky rail + mobile bottom sheet)
- consistent PageNav prev/next on every page in reading order (previously only on API pages)
- new DocsLayout wraps every page
- corrected API-doc drift against real package sources: crystal-renderer 1.0.1→2.0.0, mineral-database 2.2.0→2.3.0 + 140→216 presets + valid preset ids (quartz-prism/diamond-octahedron), crystal-geometry field rename + radians units + newly-documented public API, cdl-parser stale repr/type examples
- CDL Examples page reworked for the playground-disabled state (copy-to-clipboard per snippet, syntax-reference links into the spec, honest "coming back" callout) with the playground path preserved to auto-restore when re-enabled
- both sticky rails measured pinned through deep scroll in light+dark
- 502 tests, browser-verified
@github-actions

Copy link
Copy Markdown

🚀 Preview deployed to: https://b0592f45.gemmology-dev.pages.dev

@Bissbert
Bissbert merged commit 8af3a2e into main Jul 16, 2026
5 of 6 checks passed
@Bissbert
Bissbert deleted the fix/docs-overhaul branch July 16, 2026 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant