Skip to content

Repository files navigation

apowerb

apowerb-docs

The source of docs.apowerb.com — technical documentation for the apowerb open-core stack.

Documentation License Discord

Documentation • Quickstart • API Reference • Deployment • thaink2


Source of docs.apowerb.com — the technical documentation for the apowerb open-core stack.

Pages are MDX; navigation and theming live in docs.json.

The hosting platform does not build on push: a merge to main changes nothing on the live site until someone triggers Manual update from its dashboard. Every push here needs that second step.

Run it locally

npm i -g mint
mint dev

Serves on http://localhost:3000 and reloads on save.

Layout

docs.json              navigation, theme, tabs
index.mdx              introduction
quickstart.mdx         Docker Compose path
installation.mdx       PyPI and from-source paths
configuration.mdx      every environment variable
concepts/              architecture, editions, agents, orchestration, sessions, tools
guides/                RAG, Text-to-SQL, webhooks, integrations, streaming, orchestrator…
deployment/            Docker, database, secrets, production checks, hosting providers
monitoring/            logs, guardrails
ecosystem/             apowerb-ui, th2rag, th2etl, th2pulse
contributing/          contributing, development setup, release process
api-reference/         narrative pages + openapi.json (generated)
logo/                  placeholder wordmark and favicon

The API reference is generated

api-reference/openapi.json is not hand-written, and it is not fetched from a deployed instance either: apowerb.main removes /openapi.json, /docs and /redoc from the served routes, so a running instance has no schema endpoint. The file is generated by importing the FastAPI app from an open-source build of the core, which has none of the commercial bricks — the reference matches the open-source edition by construction rather than by filtering.

Refresh it against a clone of apowerb:

./scripts/sync-openapi.sh /path/to/apowerb/.venv/bin/python

The version stamped in info.version comes from the core's latest git tag, not from its pyproject.toml: that file stays at an old number because the release workflow injects the tag at build time. Set APOWERB_VERSION to override.

Regenerating is not optional after a release that adds or removes routes. Nothing breaks when the schema goes stale — the JSON stays valid and keeps being served — so the reference silently drifts. Diff the paths to check, never info.version.

Known gaps

  • The logo is a placeholder. logo/*.svg is a plain wordmark built from the product's blue (#0A1E72). Replace it with the real brand asset when there is one.
  • No screenshots yet. Guides that describe UI flows ("connect Google from the interface") would read better with images.
  • No search analytics, no versioning. Both are platform features, still to enable.

Conventions

Everything here is written in English, like the rest of the codebase.

License

apowerb-docs is distributed under the Apache License 2.0. Copyright 2025-2026 thaink².

"apowerb" and "thaink²" are trademarks of thaink². The licence covers the code, not the marks — see TRADEMARK.md.

About

Source of docs.apowerb.com — the technical documentation for the apowerb open-core stack.

Topics

Resources

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages