34 lines
988 B
Markdown
34 lines
988 B
Markdown
# System Overview
|
|
|
|
## Product
|
|
|
|
UI Design Code is a submodule-first design kit for Go web applications and AI coding agents.
|
|
|
|
It provides:
|
|
|
|
- canonical documentation skeletons ("Bible")
|
|
- AI instruction templates
|
|
- reusable scaffolds and UI pattern building blocks
|
|
- a sync/apply tool (`designsync`) for host repositories
|
|
- a runnable demo app for pattern reference
|
|
|
|
## Primary Consumers
|
|
|
|
- Host Go repositories using this repo as a git submodule
|
|
- AI coding agents (Codex, Claude Code, etc.)
|
|
- Developers maintaining shared UI/architecture conventions
|
|
|
|
## Runtime Composition
|
|
|
|
- Root module: tools and bundle management (`tools/designsync`)
|
|
- `kit/`: copy/sync source artifacts for host repos
|
|
- `exports/`: machine-readable bundle manifests
|
|
- `demo/`: separate Go module for browsing patterns in action
|
|
|
|
## Non-Goals (Phase 0 / bootstrap)
|
|
|
|
- No production-ready shared Go UI framework
|
|
- No host-project-specific business rules or branding
|
|
- No database/runtime dependencies for the demo
|
|
|