What is this?
This is the contributor handbook for Astrid, a guide explaining how the project's polyrepo is organized, its public contracts, the contribution process, and how releases are shipped.
This is the contributor handbook for Astrid, a guide explaining how the project's polyrepo is organized, its public contracts, the contribution process, and how releases are shipped.Is this a code library or a documentation book?It is a documentation book, not code - it's built with mdBook, a tool for turning markdown into a static handbook site.
It is a documentation book, not code - it's built with mdBook, a tool for turning markdown into a static handbook site.How do I read or build this handbook?Clone the repository and build it with mdBook (for example `mdbook build` or `mdbook serve`) to generate the browsable handbook site locally.
Clone the repository and build it with mdBook (for example `mdbook build` or `mdbook serve`) to generate the browsable handbook site locally.Is there actual Astrid application code in here?No - this repo only contains handbook content and docs tooling config; there's no application code, build scripts, or dependency list.
No - this repo only contains handbook content and docs tooling config; there's no application code, build scripts, or dependency list.What is Astrid itself, as opposed to this handbook repo?Astrid is the broader project this handbook supports, organized as a polyrepo with its own public contracts and release workflow; the actual runtime code lives in separate repositories from this one.
Astrid is the broader project this handbook supports, organized as a polyrepo with its own public contracts and release workflow; the actual runtime code lives in separate repositories from this one.What topics does the handbook actually cover?It covers the polyrepo layout, a core project rule called the 'kernel-is-dumb law', when an RFC is required, the different contribution tiers, and the release process.
It covers the polyrepo layout, a core project rule called the 'kernel-is-dumb law', when an RFC is required, the different contribution tiers, and the release process.What are similar projects?source-reading-methodology, openwiki, quarkdown, mdBook, awesome-readme, Best-README-Template, ai-system-design, mkdocs-material
source-reading-methodology, openwiki, quarkdown, mdBook, awesome-readme, Best-README-Template, ai-system-design, mkdocs-materialWhich topics is it in?oss, readme, documentation-tool, static-site-generator, best-practices, workflow, knowledge-base, book, guide, documentation, markdown, apache-2.0
oss, readme, documentation-tool, static-site-generator, best-practices, workflow, knowledge-base, book, guide, documentation, markdown, apache-2.0