From 56e16e29db55dae84549229d24b971f8bcf7da21 Mon Sep 17 00:00:00 2001 From: Owen Jacobson Date: Wed, 16 Oct 2024 01:30:44 -0400 Subject: API docs rewrite. Having the whole API in a single file was starting to feel very cramped and constraining. This rewrite breaks it out into sections; as a side effect, the docs are now about 2.5x as long as they were, as the rewrite allows more space for each idea without crowding the page. The docs are best read by running `tools/docs-api`. --- tools/docs-api | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100755 tools/docs-api (limited to 'tools/docs-api') diff --git a/tools/docs-api b/tools/docs-api new file mode 100755 index 0000000..fbc90b3 --- /dev/null +++ b/tools/docs-api @@ -0,0 +1,9 @@ +#!/bin/bash -e + +## tools/docs-api +## +## Builds (and opens) the API documentation. + +cd "$(dirname "$0")/.." + +mdbook serve --open docs/api -- cgit v1.2.3