Goobits Documentation
Welcome to the Goobits docs. This site is rendered by
@goobits/docs-engine and lives in
apps/docs. Authored guides sit alongside generated API reference so humans get
one searchable site while agents read the concise maps under .codeatlas/.
[!TIP] New here? Start with Getting Started, then skim the Architecture overview to learn how the workspace fits together.
Start by role
Use one path first. The docs are split so setup, daily workflow, package ownership, and reference lookup each have one home.
| Role | Start here | Then use |
|---|---|---|
| New developer | Getting Started | Development Workflow, Testing |
| App or feature developer | Packages | Architecture, generated TypeScript reference |
| Package maintainer | Packages | Dependency Graph, package reference pages |
| Docs author | Contributing | Operational Reference |
| Operator or support | Development Workflow | Testing, Operational Reference |
Common tasks
- Set up locally: Getting Started -> Development Workflow -> Testing.
- Find a code owner: Packages -> Glossary -> Dependency Graph.
- Look up an API: Packages -> generated reference pages below.
- Change docs safely: Contributing -> Operational Reference.
Guides
- Development Workflow: dev servers, branch routing, and committing.
- Contributing: how to write, refresh, and verify docs.
- Testing: how to run and write tests.
- Packages: the major packages and apps, and how to find things fast.
Concepts
- Architecture: how the workspace is laid out, with system and flow diagrams.
- Glossary: canonical domain terms and the package that owns each one.
Reference
Generated reference pages come from package manifests, source comments, OpenAPI, Rust metadata, and repo operational config. Start with Public Package Catalog, then use the generated sidebar for package, Rust, HTTP API, dependency graph, and operational pages.
How these docs are built
- Guides (this section) are hand-authored Markdown in
apps/docs/content/. - API reference is generated from source and checked for drift.
- Search is built in (MiniSearch), indexing every page on build.
- Rich Markdown is rendered by docs-engine. Authored guides can use callouts, Mermaid, tabs, file trees, collapse blocks, KaTeX, code metadata, and generated tables of contents. Screenshot blocks and optimized images stay disabled until their asset pipeline is intentionally owned.