Skip to content

Toborverse Data Management

Documentation for the Toborverse Data Management platform (API, web app, extraction worker, database, and cross-cutting guides).

This docs/ tree is the source of truth for this product. It is pulled into the central hub and published at:

docs.toborverse.com → section Toborverse Data Management

Hub repo: ToborlifeRobotics/ToborlifeDocs

Sections

Section Folder Notes
Backend docs/backend/ API and server-side services
Frontend docs/frontend/ Web application
Extraction Worker docs/extraction-worker/ Media and metadata extraction
Database docs/database/ Schema, design, episode/clip lifecycle
General docs/general/ Cross-cutting platform guides

The Database section has the fullest content today; other areas may still be stubs.

How publishing works

  1. Edit markdown under docs/ in this repo (branch dev).
  2. On push to docs/**, .github/workflows/notify-toborlife-docs.yml triggers ToborlifeDocs.
  3. ToborlifeDocs syncs this tree, rebuilds the full site, and deploys to Cloudflare Pages.

You do not need to update ToborlifeDocs nav by hand — it is generated from the synced folder structure.

Contributing

Add or change a page

  1. Create or edit a .md file under the right section folder, e.g. docs/backend/authentication.md.
  2. Prefer an index.md in a folder for that section’s overview.
  3. Commit and push to dev. The hub rebuilds automatically when the notify workflow is configured (DOCS_DISPATCH_TOKEN).

Nested folders become nested nav under the Toborverse Data Management section.

Database documentation

When you change SQL schema or behavior under database/, update:

  • docs/database/DATABASE.md — design rationale and overview
  • docs/database/SCHEMA_REFERENCE.md — developer reference
  • docs/database/EPISODE_CLIP_LIFECYCLE.md — episode/clip application flows

(See also workspace rules in the monorepo CLAUDE.md for required doc updates on database changes.)

Local preview (optional)

This repo still has MkDocs helpers for local browsing of only this product’s docs:

./docs.sh serve    # http://127.0.0.1:8000
./docs.sh build    # output in site/ (do not commit)

For the full multi-repo site, clone ToborlifeDocs and run ./docs.sh serve there with DOCS_READ_TOKEN set.

Git notes

  • Track markdown under docs/.
  • Do not commit site/.
  • Publishing is via ToborlifeDocs → Cloudflare, not GitHub Pages from this repo.