bublliodocs

Bubllio documentation

You do not need to read these documents in order. Pick the path that matches what you are trying to do.

Install and operate

  1. Getting started — local installation and first setup.
  2. Database setup — SQLite or PostgreSQL.
  3. Onboarding sandbox — repeat first-run setup without touching your normal development database.
  4. Production deployment — minimum production requirements.
  5. Dokploy deployment — complete Dokploy walkthrough.
  6. Production readiness — evidence required before real customer data.
  7. Updates — releases, backups, upgrades, and rollback.

Using Bubllio

These guides explain the product in business language:

Contributing

Start with Contributing, then open only the guide related to your change:

Repository-wide rules live in AGENTS.md. Focused implementation workflows live in skills/.

Architecture

Read System overview first. Continue only into the domain you are changing:

API

The checked-in Postman collection is useful for exploration. The Django views, serializers, and tests remain the authoritative API contract.

Plans and research

These pages describe direction, not shipped behavior:

Documentation rules

  • One page should answer one main question.
  • Put the outcome or quick path before background information.
  • Use tables for comparisons and code blocks only for commands or exact examples.
  • Link to the authoritative page instead of copying the same explanation.
  • Label planned behavior explicitly.
  • Keep commands runnable from the directory stated above them.
  • Remove stale instructions when behavior changes; do not preserve them as a historical narrative.