docs: add project README #350

Merged

jason.woltje merged 1 commits from docs/readme into main 2026-04-03 00:17:11 +00:00

Conversation 0 Commits 1 Files Changed 1 +244

jason.woltje commented 2026-04-03 00:12:45 +00:00

Owner

Copy Link

Adds a root README.md covering:

• Quick install one-liner
• Usage (launcher commands, TUI, management)
• Development setup (docker compose, pnpm, migrations)
• Infrastructure table (PG, Valkey, Jaeger, OTEL)
• Full architecture tree with package descriptions
• Key design decisions
• Framework layout (~/.config/mosaic/)
• Forge pipeline overview
• Upgrading instructions
• Contributing workflow

Adds a root README.md covering: - Quick install one-liner - Usage (launcher commands, TUI, management) - Development setup (docker compose, pnpm, migrations) - Infrastructure table (PG, Valkey, Jaeger, OTEL) - Full architecture tree with package descriptions - Key design decisions - Framework layout (~/.config/mosaic/) - Forge pipeline overview - Upgrading instructions - Contributing workflow

jason.woltje added 1 commit 2026-04-03 00:12:46 +00:00

docs: add project README with install, usage, architecture, and dev guide 785d30e065

jason.woltje merged commit 04db8591af into main 2026-04-03 00:17:11 +00:00

jason.woltje deleted branch docs/readme 2026-04-03 00:17:11 +00:00

jason.woltje referenced this issue from a commit 2026-04-03 00:17:13 +00:00

Merge pull request 'docs: add project README' (#350) from docs/readme into main

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

No items

No Label

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

jason.woltje

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: mosaicstack/stack#350