feat: bootstrap design kit and vaporwave demo baseline
This commit is contained in:
20
kit/docs/bible-skeleton/README.md
Normal file
20
kit/docs/bible-skeleton/README.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Project Bible
|
||||
|
||||
The Bible is the single source of truth for this project's architecture.
|
||||
|
||||
## Documentation Rules
|
||||
|
||||
- All architecture decisions must be recorded in this Bible.
|
||||
- The documentation language is English only.
|
||||
- If a decision is superseded, update the Bible immediately and remove or mark obsolete content.
|
||||
- Do not duplicate architecture documentation in `README.md`, `CLAUDE.md`, or other files.
|
||||
|
||||
## Structure
|
||||
|
||||
- `governance/documentation-policy.md` - mandatory rules for maintaining architecture docs.
|
||||
- `architecture/system-overview.md` - current scope, boundaries, and high-level system composition.
|
||||
- `architecture/api-surface.md` - HTTP API and UI route contracts.
|
||||
- `architecture/runtime-flows.md` - critical runtime behavior and failure invariants.
|
||||
- `architecture/ui-information-architecture.md` - required UI structure and semantics.
|
||||
- `decisions/README.md` - how to capture new and updated architecture decisions.
|
||||
|
||||
10
kit/docs/bible-skeleton/architecture/api-surface.md
Normal file
10
kit/docs/bible-skeleton/architecture/api-surface.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# API Surface
|
||||
|
||||
Document all HTTP endpoints and UI routes that are part of the active contract.
|
||||
|
||||
## Rules
|
||||
|
||||
- Keep request/response shapes explicit.
|
||||
- Record compatibility aliases and deprecations.
|
||||
- Update this file when route behavior changes.
|
||||
|
||||
11
kit/docs/bible-skeleton/architecture/runtime-flows.md
Normal file
11
kit/docs/bible-skeleton/architecture/runtime-flows.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Runtime Flows
|
||||
|
||||
Document the critical runtime flows and failure invariants.
|
||||
|
||||
Recommended sections:
|
||||
|
||||
- Startup flow
|
||||
- Request handling flow
|
||||
- Background tasks
|
||||
- Failure / retry / cancellation behavior
|
||||
|
||||
32
kit/docs/bible-skeleton/architecture/system-overview.md
Normal file
32
kit/docs/bible-skeleton/architecture/system-overview.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# System Overview
|
||||
|
||||
## Product
|
||||
|
||||
Describe the product in one paragraph.
|
||||
|
||||
## Active Scope
|
||||
|
||||
- List current in-scope modules/features
|
||||
- List user-visible surfaces
|
||||
- List operational responsibilities
|
||||
|
||||
## Explicitly Removed / Out of Scope
|
||||
|
||||
- List legacy or excluded modules to avoid accidental restoration
|
||||
|
||||
## Runtime Composition
|
||||
|
||||
- HTTP server package(s)
|
||||
- Domain/service orchestration
|
||||
- Persistence layer(s)
|
||||
- Migrations / background workers (if any)
|
||||
|
||||
## Local Execution
|
||||
|
||||
- `make run`
|
||||
- `go run ./cmd/<binary>`
|
||||
|
||||
## Verification
|
||||
|
||||
- `go test ./...`
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
# UI Information Architecture
|
||||
|
||||
Document page structure, required section order, UI interaction contracts, and list/filter/
|
||||
pagination behavior.
|
||||
|
||||
Use explicit route names and action contracts so AI agents can implement changes consistently.
|
||||
|
||||
18
kit/docs/bible-skeleton/decisions/README.md
Normal file
18
kit/docs/bible-skeleton/decisions/README.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Architecture Decision Records
|
||||
|
||||
Use this directory to capture architecture decisions and significant updates.
|
||||
|
||||
## Required
|
||||
|
||||
- Every architecture decision must be recorded in the Bible.
|
||||
- If a decision replaces an older one, update the older document in the same change.
|
||||
- Keep entries short, explicit, and linked to the affected architecture files.
|
||||
|
||||
## Minimal Entry Template
|
||||
|
||||
- Date (`YYYY-MM-DD`)
|
||||
- Decision
|
||||
- Context
|
||||
- Consequences
|
||||
- Supersedes (if any)
|
||||
|
||||
21
kit/docs/bible-skeleton/governance/documentation-policy.md
Normal file
21
kit/docs/bible-skeleton/governance/documentation-policy.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Documentation Policy
|
||||
|
||||
## Purpose
|
||||
|
||||
This policy defines how architectural knowledge is captured and maintained.
|
||||
|
||||
## Mandatory Rules
|
||||
|
||||
- Record every architecture decision in the Bible before or together with implementation.
|
||||
- Use English for all architecture documentation.
|
||||
- Keep only current architecture in active sections.
|
||||
- When a solution is replaced, update or remove obsolete guidance in the same change.
|
||||
- Keep architecture details centralized in `bible/`; other top-level docs should only reference it.
|
||||
|
||||
## Change Workflow
|
||||
|
||||
1. Update the relevant file(s) in `bible/architecture/`.
|
||||
2. If behavior changed, add or update a decision note in `bible/decisions/`.
|
||||
3. Remove duplicated or outdated statements from non-Bible docs.
|
||||
4. Validate consistency against current code paths.
|
||||
|
||||
Reference in New Issue
Block a user