book README

The project's README from github.com/astrid-runtime/book. As one markdown file: README.md.

The Astrid Book

The canonical reference for Astrid: the kernel, the capsule model, the host ABI, the bus, and the security model.

Built with mdBook.

mdbook serve --open

The reference appendices (capability catalog, host ABI error codes, topic registry) are generated from the Astrid source by tools/gen-appendices.sh. The cross-chapter "See also" footers are generated by tools/gen-see-also.pl. Both read the polyrepo source tree, so run them from a checkout that has core/, wit/, and capsules/ as siblings.

Dual-licensed under MIT and Apache 2.0.

Copyright (c) 2025-2026 Joshua J. Bouw and Unicity Labs.

book (astrid-runtime/book)

Searching Database…

7.5K ·GitHub
What is this?This is the official reference book for Astrid, covering its kernel, capsule model, host ABI, IPC bus, and security model.
Is this Astrid itself or just the documentation?It's a static documentation book built with mdBook, not runtime software; it describes Astrid rather than running it.
How do I build this book?Check it out as a sibling to the core/, wit/, and capsules/ repos of the Astrid polyrepo, run the appendix generator scripts, then build with mdBook.
Do I need the rest of the Astrid source tree to build this?Yes. The appendices are generated by tools/gen-appendices.sh and the cross-chapter links by tools/gen-see-also.pl, and both scripts read the full polyrepo source.
Can I build it as a standalone checkout?No, building a fully accurate copy requires the core/, wit/, and capsules/ repos checked out alongside this one, since the generator scripts read across them.
What does the generated capability catalog appendix cover?It is produced by tools/gen-appendices.sh and includes the capability catalog, host ABI error codes, and the topic registry pulled directly from Astrid's source.
Why does a Perl script handle the cross-chapter links?tools/gen-see-also.pl scans the polyrepo source to auto-generate the 'See also' footers that connect related chapters across the book.
Size
0.3 MB
Stars
7.5K
Updated
CommitSep 08
Age
4mo
Commits · 90 Days