Swarm Docs¶
One URL. Every project. All docs.
Welcome to the unified documentation hub for the Swarm — platform, apps, and ideas in one place.
What's Here¶
- :material-cog: **Platform**
---
Shared platform library, Flutter monorepo, CI/CD, architecture decisions, and conventions.
[:octicons-arrow-right-24: Platform Docs](platform/index.md)
- :material-rocket-launch: **Apps**
---
Every app the Swarm builds — purpose, architecture, setup, API reference, and changelogs.
[:octicons-arrow-right-24: App Docs](apps/index.md)
- :material-lightbulb: **Ideas**
---
Active ideas under evaluation, the scoring criteria, and the full history of ideas we've considered.
[:octicons-arrow-right-24: Idea Pipeline](ideas/index.md)
Documentation Convention¶
Every repo in the Swarm has a docs/ folder. No exceptions.
- Platform docs live in
swarm/platform/core - App docs live alongside their code in
swarm/apps/<name> - Idea docs live in
swarm/idea/pipeline - ADRs use MADR format in
docs/adr/ - Docs are reviewed in MR like code — no docs page = MR blocked
See Conventions for the full doc standard.
Contributing¶
Spotted something wrong? Open an MR in the relevant repo. Questions? Check Contributing.