summaryrefslogtreecommitdiff
path: root/tools/docs-developer
diff options
context:
space:
mode:
authorOwen Jacobson <owen@grimoire.ca>2025-06-23 22:45:18 -0400
committerOwen Jacobson <owen@grimoire.ca>2025-07-01 20:25:30 -0400
commitc38d877b94c6ac5df2de4c9c939ae683d733e8b8 (patch)
treef8d02380dfef622656710b1412900eb21cc42656 /tools/docs-developer
parentc0c825477e476d6d7331bfc409bceff9c376b484 (diff)
Organize the developer docs into a "Pilcrow for Developers" book.
The audience for this is developers looking to make changes to Pilcrow, either on the server, on the included client, or via its data model. Most of the material here is drawn from existing documents, but organized somewhat more coherently. I've left some space for client documentation, though no such documents exist yet.
Diffstat (limited to 'tools/docs-developer')
-rwxr-xr-xtools/docs-developer9
1 files changed, 9 insertions, 0 deletions
diff --git a/tools/docs-developer b/tools/docs-developer
new file mode 100755
index 0000000..bb042d1
--- /dev/null
+++ b/tools/docs-developer
@@ -0,0 +1,9 @@
+#!/bin/bash -e
+
+## tools/docs-developer
+##
+## Builds (and opens) the developer documentation.
+
+cd "$(dirname "$0")/.."
+
+mdbook serve --open docs/developer