a0005a05
docs: full reference + how-to set, migrate Makefile to Justfile
Documentation overhaul that adds the missing user-facing surface: four reference pages (runtime-api, generated-api, cli, grpc-contract), twelve how-tos walking from first-message through custom transports, a troubleshooting page, and a docs/index map. Every how-to references a runnable artifact under examples/, all of them verified end-to-end. Build system migration: the Makefile is gone; the Justfile is now the canonical entry point and absorbs every target. examples/Justfile ships one recipe per runnable example, forwarded via top-level 'just examples <name>'. The 'examples are part of the documented surface' convention is pinned in CLAUDE.md, alongside a dedicated section on updating the conformance harness (PROTOBUF_TAG bumps, libjsoncpp path drift, new test-category wiring). Stale-number sweep across README/PLAN/CLAUDE: fixture count 18→10, test count 613/130→639, wire.lua LOC dropped, M7 marked done. Descriptor-shape block deduplicated against codegen.md as the canonical source. gRPC transports spec status reframed from 'draft / decision deferred' to 'shipped contract; external transports deferred'. .gitignore picks up *.snap / *.xlog / *.vylog / *.run / *.pid / 512.lock so example state can't leak into the working tree.
Eugene Blikh <bigbes@gmail.com> — 2026-05-16 20:13:29 UTC
Commit a0005a0576092d45f73bfcc87200ab6a721d5c3a —
view raw patch
Parent(s):
ab214a39
| File | Status | + | − |
|---|---|---|---|
.gitignore
|
M | +12 | -1 |
Justfile
|
M | +184 | -14 |
Makefile
|
D | -135 | |
PLAN.md
|
M | +69 | -102 |
README.md
|
M | +27 | -20 |
docs/api-modes.md
|
M | +11 | -14 |
docs/codegen.md
|
M | +13 | -11 |
docs/howto/01-first-message.md
|
A | +133 | |
docs/howto/02-module-layout.md
|
A | +178 | |
docs/howto/03-grpc-loopback.md
|
A | +250 | |
docs/howto/04-wkt-struct-value.md
|
A | +150 | |
docs/howto/05-wkt-any.md
|
A | +156 | |
docs/howto/06-json-http.md
|
A | +160 | |
docs/howto/07-text-format.md
|
A | +117 | |
docs/howto/08-dynamic-schemas.md
|
A | +178 | |
docs/howto/09-lazy-when.md
|
A | +142 | |
docs/howto/11-migrate-from-builtin.md
|
A | +177 | |
docs/howto/12-build-integration.md
|
A | +212 | |
docs/howto/13-custom-transport.md
|
A | +207 | |
docs/index.md
|
A | +88 | |
docs/reference/cli.md
|
A | +181 | |
docs/reference/generated-api.md
|
A | +253 | |
docs/reference/grpc-contract.md
|
A | +204 | |
docs/reference/runtime-api.md
|
A | +283 | |
docs/specs/grpc_transports.md
|
M | +9 | -4 |
docs/troubleshooting.md
|
A | +276 | |
examples/Justfile
|
A | +57 | |
examples/dynamic/load_from_space.lua
|
A | +105 | |
examples/expected/full/quickstart/quickstart_pb.lua
|
A | +151 | |
examples/expected/runtime/quickstart/quickstart_pb.lua
|
A | +65 | |
examples/grpc/client.lua
|
A | +64 | |
examples/grpc/server.lua
|
A | +59 | |
examples/grpc/transport_netbox_stub.lua
|
A | +63 | |
examples/http/json_api.lua
|
A | +59 | |
examples/proto/quickstart.proto
|
A | +25 |