Transit documentation
Read the published handbook, starting with What is Transit?, the data model and your first dataset.
Guides and reference
Use Choose an interface to select a supported profile, then the interface map for its usage, contracts and technical explanations. Internals explains the system's models, mechanisms and evidence.
Where documentation lives
| Section | Contents |
|---|---|
| Guides | Tutorials and workflows for using and operating Transit |
| Reference | Concepts, interfaces, configuration, limits and compatibility |
| Internals | System models, invariants, rationale and evidence |
| SDKs | Language installation and API guides owned by sdks/<language>/ |
| Components | Package/app READMEs and component integration guides |
| Contracts | Exact wire formats, schemas, ABIs and shared fixtures |
| Examples | Complete applications and public API callers |
| Proof ledger | Executed checks, measurements and verification limits |
| Roadmap | Delivery scope, dependencies, acceptance criteria and status |
| Design | UI/UX proposals, visual studies and review outcomes |
| History | Earlier technical accounts and qualification records |
| Handbook project | Site tooling, previews, navigation and publication |
Update and verify
Follow the shared documentation instructions and the scoped Handbook, Design or Roadmap instructions for the section you change. The site guide explains documentation checks; the contributor guide covers repository work.