The documentation for running, using and configuring Labs64.IO. Part of the Labs64.IO Ecosystem: the source of the documentation site at labs64.io/docs.
Get started · Features · AI agents · Ecosystem · Documentation · labs64.io
Note
This repository owns technical reference and onboarding, not marketing. Module status and versions come from the website's _data/modules.yml and are never restated in pages.
Good documentation is read by people who are in the middle of something: trying to get a first request through, or deciding whether this is the right tool for the team. This site is organised around what they are doing.
- Get started. A five-minute Quickstart and a comparison of every way to run Labs64.IO.
- Use a module. One reference per module: capabilities, API, configuration, events, operations and troubleshooting.
- Change the code. A contributor guide, the workspace layout and the OpenAPI-first workflow.
A good fit if
- You want to run, use or configure a Labs64.IO module and need the reference.
- You are evaluating the platform and want to compare the ways to run it.
- You found a page that is wrong or missing and want to fix it.
Probably not what you need if
- You are looking for marketing or positioning: that lives on labs64.io.
- You want internal design records: those are in a private repository.
- Adopter guides: quickstart, one module, your own cluster, the whole ecosystem from source, troubleshooting.
- Module references: AuditFlow, Auth Gateway, Checkout, Payment Gateway and Customer Portal, each with capabilities, API, configuration and operations.
- Contributor handbook: build and test a module, the OpenAPI-first workflow, workspace layout.
- Diagrams as code: Mermaid in any page.
- Machine-readable:
llms.txtand full-text exports for agents. - Docker-first: preview, build and link-check without installing Ruby.
| You want… | Look in |
|---|---|
| The five-minute path | getting-started/quickstart.md |
| To choose how to run it | getting-started/ |
| A module's API, configuration and operations | modules/<module>/ |
| How it fits together | introduction/architecture.md |
| To change the code | development/contributing.md |
The published site is at labs64.io/docs.
The docs are plain Markdown with an llms.txt index, so agents can read them too. The guide for AI agents covers authentication, retries and errors across all modules. Working on this repository with an agent? AGENTS.md and CLAUDE.md describe conventions and verification.
Docs is one module of the Labs64.IO Ecosystem. All modules are listed in the documentation.
We would love your help. Found a typo, a stale command or a missing explanation? A one-line fix is a real contribution here. Fork the repository, make your change on a branch, run the checks described in AGENTS.md and open a pull request. Not sure whether an idea fits? Open an issue first and we will talk it through; that is a perfectly good way to start.
Licensed under the Apache License 2.0.
Made by the Labs64 team and community.
