How to navigate the docs¶
This site follows the Diátaxis framework, which organizes content into four quadrants based on the reader's intent.
The four quadrants¶
| Quadrant | Path | Purpose | Audience |
|---|---|---|---|
| Tutorials | tutorials/ | Learning-oriented guides. Walk a newcomer through a task end-to-end so they learn by doing. | New to the project |
| How-to | how-to/ | Task-oriented guides. Solve a specific, real-world problem. Assumes some familiarity. | Practitioners |
| Reference | reference/ | Information-oriented. Describe the machinery neutrally — APIs, schemas, config. No explanation. | Anyone who needs a fact |
| Explanation | explanation/ | Understanding-oriented. Discourse, background, trade-offs, and Architecture Decision Records (ADRs). | People who want the "why" |
Highlights¶
- Architecture Decision Records — every major design choice, from the runtime to the ontology i18n strategy.
- Data model reference — tables, fields, types, and constraints.
- Book classification ontology — the 9 Types, genre hierarchies, and modifier vocabularies.
- Contributor guides — coding style, documentation style, Cloudflare Workers reference.
How to choose what to read¶
- New to TomeTrove? Start with Tutorials.
- Need to do something specific? Look in How-to guides.
- Need to look up a fact (API, schema, config)? Go to Reference.
- Want to understand why a decision was made? Read Explanation and the ADRs.