sharang
cb50fc5026
ci / shared (pull_request) Failing after 3s
Apply the platform-domain decision (2026-05-18) to every README, workflow, and config in this repo. 7 files updated. Refs: M1.1
60 lines
2.4 KiB
Markdown
60 lines
2.4 KiB
Markdown
# docs
|
|
|
|
Platform-wide architecture, integration spec, runbooks.
|
|
|
|
> Part of the **Breakpilot Platform**. For the big picture see [`platform/docs`](https://gitea.meghsakha.com/platform/docs):
|
|
> [Architecture](https://gitea.meghsakha.com/platform/docs/src/branch/main/PLATFORM_ARCHITECTURE.md) ·
|
|
> [Infrastructure](https://gitea.meghsakha.com/platform/docs/src/branch/main/INFRASTRUCTURE.md) ·
|
|
> [Product Integration Spec](https://gitea.meghsakha.com/platform/docs/src/branch/main/PRODUCT_INTEGRATION_SPEC.md) ·
|
|
> [Implementation Plan](https://gitea.meghsakha.com/platform/docs/src/branch/main/IMPLEMENTATION_PLAN.md)
|
|
|
|
## What this is
|
|
|
|
Platform-wide architecture, integration spec, runbooks. Scaffolded under milestone M0.1. See [`platform/docs`](https://gitea.meghsakha.com/platform/docs) for the full architecture context.
|
|
|
|
**Plane:** Control
|
|
**Owner:** @sharang
|
|
**Status:** pre-alpha
|
|
**Linked milestone:** [M0.1](https://gitea.meghsakha.com/platform/docs/src/branch/main/IMPLEMENTATION_PLAN.md)
|
|
|
|
## Run locally
|
|
|
|
```bash
|
|
# prerequisites: see CONTRIBUTING.md for tooling once code lands
|
|
make dev # starts dependencies + this service on http://localhost:3000
|
|
make test # unit + integration
|
|
make e2e # only if this repo ships user-facing flows
|
|
```
|
|
|
|
Local secrets come from `.env.local` (gitignored). Template at `.env.example`.
|
|
|
|
## Endpoints / surface
|
|
|
|
{{For services: list the top-level routes or commands.
|
|
For libraries: list the public API entry points.
|
|
For IaC: list the make targets.}}
|
|
|
|
## Deployment
|
|
|
|
| Env | URL | How |
|
|
|---|---|---|
|
|
| dev | `http://localhost:3000` | `make dev` |
|
|
| stage | `https://docs.stage.breakpilot.com` | auto on merge to `main` |
|
|
| prod | `https://docs.breakpilot.com` | manual: tag `vX.Y.Z` + sign-off |
|
|
|
|
Rollback: `orca rollout undo docs --env={{env}}`.
|
|
|
|
## Observability
|
|
|
|
- Traces, logs, metrics: [SigNoz](https://signoz.meghsakha.com) — service name `docs`
|
|
- Audit events: Tenant Registry `/audit` (Retraced-shape schema)
|
|
- On-call: `oncall@breakpilot.com` · runbook at `platform/docs/runbooks/docs.md`
|
|
|
|
## Contributing
|
|
|
|
See [`CONTRIBUTING.md`](./CONTRIBUTING.md). TL;DR: branch from main, open a PR, 1 review + green CI, squash-merge.
|
|
|
|
## License
|
|
|
|
Proprietary — all rights reserved. Copyright (c) 2026 Sharang Parnerkar and Benjamin Boenisch. See [`LICENSE`](./LICENSE).
|