Skip to content

docs: restructure navigation around Diataxis framework#82

Merged
rororowyourboat merged 4 commits intomainfrom
dev
Mar 4, 2026
Merged

docs: restructure navigation around Diataxis framework#82
rororowyourboat merged 4 commits intomainfrom
dev

Conversation

@rororowyourboat
Copy link
Collaborator

Summary

  • Reorganize docs nav into 4 Diataxis tabs: Learn, How-To Guides, Reference, Design & Research
  • Add navigation.tabs, navigation.instant, navigation.indexes, navigation.top theme features; remove navigation.expand
  • Rewrite home page with "where to start" cards and interactive marimo notebook highlights
  • No files moved/renamed — only mkdocs.yml nav and docs/index.md changed

Test plan

  • uv run mkdocs build --strict passes with zero warnings
  • uv run ruff check and uv run ruff format --check pass
  • All package tests pass (3 pre-existing gds-sim failures unrelated)
  • Visual check: tabs render correctly, sidebar collapses properly
  • Spot-check internal links from tutorials and guide pages

- Fix mermaid subgraph reference in evolution-of-trust diagram
  (use ID[Label] syntax for subgraph nodes)
- Fix two dead anchors in dsl-roadmap.md pointing to removed
  architecture sections
Reorganize docs into four top-level tabs (Learn, How-To Guides,
Reference, Design & Research) for clearer user journey. Add
navigation.tabs, navigation.instant, and navigation.top theme
features. Rewrite home page with "where to start" cards and
interactive marimo notebook section.
…en unavailable

Use fork mp_context in ProcessPoolExecutor to avoid pickle failures
with importlib test import mode. Skip to_dataframe tests when pandas
is not installed since it's an optional dependency.
@rororowyourboat rororowyourboat merged commit 52003f6 into main Mar 4, 2026
10 checks passed
rororowyourboat added a commit that referenced this pull request Mar 4, 2026
Merge pull request #82 from BlockScience/dev
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