Skip to content

Commit 0ea58e0

Browse files
committed
Rewrite docs and update mdbook theme for 0.5.2
Rewrite all doc pages to be accurate and concise: - introduction.md: explains the actual purpose (type safety overlay, not a new interface), real CLI commands - type-mapper.md: focused reference with mapping tables - examples.md: fixed generated code to match actual output (removed phantom .instance path, wrong nullOr wrapping, nonexistent config/... wrapper) - design-overview.md: condensed from 540 to 85 lines, pipeline diagram, module table, key design decisions Remove pages for unbuilt features: - option-builder.md (internal API docs with wrong test counts) - documentation-generation.md (680-line plan for unimplemented feature) Update index.hbs to stock mdbook 0.5.2 template (old one used removed {{#previous}}/{{#next}} block helpers) with catppuccin theme buttons.
1 parent 79d0f5d commit 0ea58e0

9 files changed

Lines changed: 340 additions & 2763 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@ result-*
1818

1919
# treefmt-nix
2020
.treefmt.toml
21+
22+
# mdbook
23+
docs/book/

docs/src/SUMMARY.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,6 @@
22

33
[Introduction](./introduction.md)
44

5-
# Design
6-
7-
- [Design Overview](./design-overview.md)
5+
- [Type Mapping](./type-mapper.md)
86
- [Transformation Examples](./examples.md)
9-
- [Documentation Generation](./documentation-generation.md)
10-
11-
# Implementation
12-
13-
- [Type Mapper](./type-mapper.md)
14-
- [Option Builder](./option-builder.md)
7+
- [Architecture](./design-overview.md)

0 commit comments

Comments
 (0)