feat: bootstrap design kit and vaporwave demo baseline
This commit is contained in:
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.
|
||||
|
||||
Reference in New Issue
Block a user