Entry point: ../README.md
| Document | Purpose |
|---|---|
| ../README.md | Product overview, quick start, and what ships today |
| START_HERE.md | Current onboarding path for new Quark projects |
| FIRST_FEATURE.md | Canonical first feature walkthrough |
| QUARK_USAGE.md | Full development and CLI workflow |
| Document | Purpose |
|---|---|
| ../packages/ui/README.md | UI package catalog and import rules |
| ../packages/jobs/README.md | Jobs package, worker pairing, and extension points |
| AI_TOOLS.md | AI coding tools guide (Claude Code, Cursor, Copilot) |
| UMAMI.md | Optional Umami integration review and setup guidance |
| Document | Purpose |
|---|---|
| ARCHITECTURE.md |
| Core-Only Registry model and distribution philosophy |
| openapi.yaml | REST contract for the scaffolded app |
| DATABASE.md | Database schema, models, query helpers, and best practices |
| EXAMPLES.md | Domain model examples (blog posts, products, contacts, teams) |
| API.md | REST endpoint reference |
| dependency-audit.md | Dependency vulnerability triage, accepted risks, and overrides |
| MAINTAINABILITY.md | Code style, testing, and dependency management |
| TESTING_INFRASTRUCTURE.md | Testing organization, CI/CD, utilities, and patterns |
| copilot-instructions.md | Monorepo Copilot contributor context |
| AGENTS.md | Monorepo agent contributor context |
| .cursor/rules/quark.mdc | Monorepo Cursor contributor rules |
| Document | Purpose |
|---|---|
| DEPLOY_RAILWAY.md | Railway deployment, env vars, and troubleshooting |
| TROUBLESHOOTING.md | Common failures and their fixes |
| SECURITY_FEATURES.md | Security features, checklists, and incident response |
| DESIGN_NOTES.md | Design direction, partly superseded. Read the status banner first |
| Document | Purpose |
|---|---|
| ARCHIVE.md | Entry point for older planning material and why it was archived |
| ROADMAP.md | Original expansion roadmap (predates skill-based architecture) |
| IMPLEMENTATION_CHECKLIST.md | Task tracker with progress percentages |
| FEATURE_PLAN.md | Isolated, agent-executable feature plan (F1–F8) |
| PHASE2_PLAN.md | Admin-package exploration. Historical only; the admin package was removed |
| MERGE_PLAN.md | Sequence to merge the scaffold opinionation work into main |
| strategy/ | Archived strategy specs: unimplemented template improvements, i18n reference |