Skip to content

Apps

Every app the Swarm builds is documented here.

Active Apps

App Status Repo
Demo App 🟢 Active swarm/platform/demo-app

Adding a New App

When a new app repo is created:

  1. Add a docs/ folder with at least these pages:
  2. docs/index.md — app purpose and target user
  3. docs/architecture.md — technical overview
  4. docs/setup.md — how to run it locally
  5. docs/api.md — API / data model reference

  6. docs/changelog.md — release history

  7. Add a mkdocs.yml pointing to your docs/ folder

  8. Register the repo in the central CI pipeline (platform/core .gitlab-ci.yml)
  9. The next CI run will include your docs at https://docs.swarm-labs.org/apps/<name>/

Documentation Standard

Every app must document:

  • Purpose — what problem it solves and for whom
  • Architecture — how it's built and why
  • Setup — how to run it locally in <5 minutes
  • API — every external interface
  • Changelog — what changed in each release

See Conventions for the full documentation standard.