From c38d877b94c6ac5df2de4c9c939ae683d733e8b8 Mon Sep 17 00:00:00 2001 From: Owen Jacobson Date: Mon, 23 Jun 2025 22:45:18 -0400 Subject: 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. --- docs/developer/SUMMARY.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/developer/SUMMARY.md (limited to 'docs/developer/SUMMARY.md') diff --git a/docs/developer/SUMMARY.md b/docs/developer/SUMMARY.md new file mode 100644 index 0000000..6b0ce6a --- /dev/null +++ b/docs/developer/SUMMARY.md @@ -0,0 +1,20 @@ +# Summary + +[Introduction](introduction.md) + +- [Design guidance](design-guidance.md) + +# The server + +- [Code organization](server/code-organization.md) +- [Data models](server/data-models.md) +- [Time](server/time.md) +- [Errors](server/errors.md) +- [Testing](server/testing.md) +- [Running Pilcrow locally](server/running.md) +- [Debian packaging](server/debian-packaging.md) + +# Development tools + +- [Formatting](tools/formatting.md) +- [Linting](tools/linting.md) -- cgit v1.2.3