Skip to content

Commit bdda657

Browse files
authored
docs: add initial adrs and nav (#550)
1 parent f451002 commit bdda657

File tree

4 files changed

+49
-0
lines changed

4 files changed

+49
-0
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# ADR 0001: Platform Foundation and Documentation Stack
2+
3+
## Status
4+
Accepted
5+
6+
## Context
7+
The project consolidates multiple services, documentation, and operational guides intended to onboard engineers rapidly. We needed a consistent documentation platform capable of integrating backend, frontend, and DevOps guidance while supporting Markdown authoring, custom styling, and diagrams.
8+
9+
## Decision
10+
We standardize on **MkDocs Material** as the documentation engine and keep all narrative and architectural documentation within the `docs/` directory. ADRs, runbooks, and onboarding guides follow Markdown conventions and leverage MkDocs features (admonitions, syntax highlighting, and navigation tabs) to present cohesive guidance.
11+
12+
## Consequences
13+
- Contributors can document decisions using Markdown without additional tooling.
14+
- Documentation builds remain reproducible via `mkdocs serve` and `mkdocs build`.
15+
- Any new architectural decision records must be added under `docs/adrs/` and referenced in `mkdocs.yml` to surface in the navigation menu.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# ADR 0002: Service-Oriented Application Layout
2+
3+
## Status
4+
Accepted
5+
6+
## Context
7+
The platform serves multiple personas (administrators, analysts, and external applications) and requires separation between the API, admin tooling, and public frontend. A monolithic structure would slow independent deployment and testing.
8+
9+
## Decision
10+
We organize the codebase into discrete service directories (`backend/`, `frontend/`, `supabase/`, and specialized tooling) with shared libraries under `packages/`. Each service exposes its own deployment pipeline while sharing infrastructure definitions through Docker Compose and Terraform modules.
11+
12+
## Consequences
13+
- Teams can develop and deploy components independently while reusing shared utilities.
14+
- CI/CD pipelines can target specific services for faster feedback loops.
15+
- Cross-service changes require coordination through clearly versioned shared packages and documentation updates.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# ADR 0003: Supabase for Managed Auth and Data Storage
2+
3+
## Status
4+
Accepted
5+
6+
## Context
7+
We require a hosted persistence and authentication layer that integrates with the frontend quickly, supports row-level security, and provides realtime capabilities without building bespoke infrastructure.
8+
9+
## Decision
10+
We adopt Supabase to provide PostgreSQL storage, authentication flows, and policy management. The `supabase/` directory houses configuration, migrations, and policy definitions, which are synchronized through CLI tooling and referenced in the docs for contributors.
11+
12+
## Consequences
13+
- Supabase delivers managed authentication, storage, and realtime subscriptions with minimal setup.
14+
- Local development requires developers to run the Supabase stack via Docker Compose or connect to managed instances.
15+
- Architectural changes impacting data models must be reflected in Supabase migrations and documented policies.

mkdocs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ nav:
3737
- Docker and Deployment: docker-deployment.md
3838
- Release Checklist: release-checklist.md
3939
- Architecture: ARCHITECTURE.md
40+
- ADRs:
41+
- Platform Foundation and Documentation Stack: adrs/adr-0001-platform-foundation.md
42+
- Service-Oriented Application Layout: adrs/adr-0002-service-architecture.md
43+
- Supabase for Managed Auth and Data Storage: adrs/adr-0003-supabase-integration.md
4044
- API Spec: API_SPEC.md
4145
- AI Engine: AI_ENGINE.md
4246
- GLB Asset Standard: GLB_ASSET_STANDARD.md

0 commit comments

Comments
 (0)