@donotdev/cli 0.0.20 → 0.0.21

package/templates/root-consumer/guides/wai-way/hld_template.md.example

@@ -0,0 +1,138 @@
+# High-Level Design (HLD)
+
+> **Version:** V1
+> **Status:** Draft | Validated
+> **Last Updated:** [date]
+>
+> This document is the HOW (big picture) — architecture, preset, auth, pages, features.
+> Produced by Phase 0 (BRAINSTORM) from `spec_template.md` conversation.
+
+---
+
+## 1. Preset Selection
+
+**Selected:** `_______________`
+
+| Preset | When to Use |
+|--------|-------------|
+| `landing` | Marketing site, public pages, conversion focus |
+| `admin` | Dashboard with sidebar, CRUD-heavy, internal tools |
+| `moolti` | Multi-tenant SaaS, teams/workspaces, billing |
+| `docs` | Documentation, auto-sidebar from pages |
+| `blog` | Content-focused, articles, archive |
+| `game` | Mobile-first, fullscreen, minimal chrome |
+| `plain` | Custom everything, no framework layout |
+
+**Rationale:** [Why this preset fits]
+
+---
+
+## 2. Auth Model
+
+| Question | Answer |
+|----------|--------|
+| **Auth required?** | Yes / No |
+| **Providers** | [ ] Email [ ] Google [ ] GitHub [ ] Apple |
+| **Self-registration?** | Yes / No / Invite-only |
+
+### Roles
+
+| Role | Description | Can Do |
+|------|-------------|--------|
+| `guest` | Not logged in | |
+| `user` | Logged in | |
+| `admin` | Administrator | |
+
+---
+
+## 3. Billing Model (if applicable)
+
+| Question | Answer |
+|----------|--------|
+| **Billing enabled?** | Yes / No |
+| **Model** | Subscription / One-time / Usage-based |
+| **Provider** | Stripe / Other |
+
+### Plans
+
+| Plan | Price | Features |
+|------|-------|----------|
+| | | |
+
+---
+
+## 4. Aesthetic Essence
+
+**Selected:** SaaS (Default) / Luxury / Brutalist / Custom
+
+**Application:** [How it affects colors, typography, spacing]
+
+---
+
+## 5. Page Map
+
+> Every page traces back to a user journey in PRD.md.
+
+### Public Pages
+
+| Route | Page | Purpose | From Journey |
+|-------|------|---------|--------------|
+| `/` | HomePage | | |
+
+### Protected Pages (login required)
+
+| Route | Page | Purpose | From Journey |
+|-------|------|---------|--------------|
+| `/dashboard` | DashboardPage | | |
+
+### Admin Pages
+
+| Route | Page | Purpose | From Journey |
+|-------|------|---------|--------------|
+| `/admin` | AdminDashboard | | |
+
+---
+
+## 6. Entity Relationship Diagram
+
+> Text-based overview. Detailed per-entity specs are in LLD.md.
+
+```
+[Entity A] 1──N [Entity B]
+[Entity B] N──1 [Entity C]
+[Entity A] 1──1 [Entity D]
+```
+
+---
+
+## 7. Feature Flags
+
+| Feature | Needed | Details |
+|---------|--------|---------|
+| **i18n** | Yes/No | Languages: |
+| **PWA** | Yes/No | |
+| **Real-time** | Yes/No | Which entities: |
+| **File uploads** | Yes/No | Which entities: |
+| **Email notifications** | Yes/No | Triggers: |
+| **Search** | Yes/No | Which entities: |
+| **Export (CSV/PDF)** | Yes/No | Which entities: |
+
+---
+
+## 8. Architecture Decisions
+
+| Decision | Choice | Rationale | Alternatives Considered |
+|----------|--------|-----------|------------------------|
+| | | | |
+
+---
+
+## Validation Checklist
+
+- [ ] Preset selected with rationale
+- [ ] Auth model complete (providers, roles, registration)
+- [ ] Every page traces back to a PRD journey
+- [ ] Entity relationships mapped
+- [ ] Feature flags decided (no "TBD")
+- [ ] Architecture decisions documented
+- [ ] User has reviewed and confirmed this document

package/templates/root-consumer/guides/wai-way/lld_template.md.example

@@ -0,0 +1,103 @@
+# Low-Level Design (LLD)
+
+> **Version:** V1
+> **Status:** Draft | Validated
+> **Last Updated:** [date]
+>
+> This document is the HOW (detailed) — per-entity field specs, state machines, validation rules, access matrices.
+> Produced by Phase 0 (BRAINSTORM) from `spec_template.md` conversation.
+> This is the Builder's blueprint — Phase 2 (ENTITIES) consumes this directly.
+
+---
+
+## Entity: [Name]
+
+### Fields
+
+| Field | Type | Required | Validation | Visibility |
+|-------|------|----------|------------|------------|
+| id | string | yes | auto-generated | guest |
+| | | | | |
+| createdAt | timestamp | yes | auto | admin |
+| updatedAt | timestamp | yes | auto | admin |
+
+### State Machine
+
+**States:** `[state1]` → `[state2]` → `[state3]`
+
+| From | To | Trigger | Who Can | Side Effects |
+|------|----|---------|---------|-------------|
+| state1 | state2 | [action] | [role] | [what happens] |
+| state2 | state3 | [action] | [role] | [what happens] |
+| state2 | cancelled | [action] | [role] | [what happens] |
+
+### Relationships
+
+| Type | Target Entity | Via Field | Cascade Rule |
+|------|---------------|-----------|-------------|
+| belongs-to | [Entity] | [fieldName] | [on delete: cascade/nullify/restrict] |
+| has-many | [Entity] | [foreignKey] | [on delete: cascade/orphan] |
+
+### Access Matrix
+
+| Action | guest | user | owner | admin | Conditions |
+|--------|-------|------|-------|-------|------------|
+| Create | | | | | |
+| Read | | | | | |
+| Update | | | | | |
+| Delete | | | | | |
+
+---
+
+## Entity: [Name]
+
+### Fields
+
+| Field | Type | Required | Validation | Visibility |
+|-------|------|----------|------------|------------|
+| | | | | |
+
+### State Machine
+
+_(if applicable)_
+
+### Relationships
+
+| Type | Target Entity | Via Field | Cascade Rule |
+|------|---------------|-----------|-------------|
+| | | | |
+
+### Access Matrix
+
+| Action | guest | user | owner | admin | Conditions |
+|--------|-------|------|-------|-------|------------|
+| Create | | | | | |
+| Read | | | | | |
+| Update | | | | | |
+| Delete | | | | | |
+
+---
+
+_(Copy entity block for each entity)_
+
+---
+
+## Cross-Entity Validation Rules
+
+> Rules that span multiple entities.
+
+| Rule | Entities Involved | Logic |
+|------|-------------------|-------|
+| | | |
+
+---
+
+## Validation Checklist
+
+- [ ] Every entity has complete field definitions (type, required, validation)
+- [ ] Every entity with states has a full state machine (from/to/trigger/who/side-effects)
+- [ ] Every entity has relationships defined with cascade rules
+- [ ] Every entity has CRUD access matrix for every role
+- [ ] Cross-entity validation rules documented
+- [ ] No "TBD", "TODO", or empty fields
+- [ ] User has reviewed and confirmed this document

package/templates/root-consumer/guides/wai-way/prd_template.md.example

@@ -0,0 +1,140 @@
+# Product Requirements Document (PRD)
+
+> **Version:** V1
+> **Status:** Draft | Validated
+> **Last Updated:** [date]
+>
+> This document is the WHAT — what users need, what the product does, what rules govern behavior.
+> Produced by Phase 0 (BRAINSTORM) from `spec_template.md` conversation.
+
+---
+
+## 1. Identity
+
+| Field | Value |
+|-------|-------|
+| **App Name** | |
+| **One-Line Description** | |
+| **Primary User** | _(Who uses this daily?)_ |
+| **Secondary Users** | _(Who else interacts?)_ |
+| **Core Value** | _(What problem does it solve?)_ |
+| **North Star Action** | _(The ONE thing users MUST do — max 2 clicks from home)_ |
+
+---
+
+## 2. User Journeys
+
+> Most important section. Every page, entity, and rule traces back to a journey.
+
+### Journey 1: [Name — e.g., "New User Onboarding"]
+
+**Actor:** [User type]
+**Goal:** [What they're trying to accomplish]
+**Trigger:** [What starts this journey]
+
+**Steps:**
+1.
+2.
+3.
+4.
+5.
+
+**Success:** [What indicates completion]
+**Failure:** [What could go wrong, how to handle]
+
+---
+
+### Journey 2: [Name — e.g., "Daily Core Task"]
+
+**Actor:** [User type]
+**Goal:** [What they're trying to accomplish]
+**Trigger:** [What starts this journey]
+
+**Steps:**
+1.
+2.
+3.
+4.
+5.
+
+**Success:** [What indicates completion]
+**Failure:** [What could go wrong, how to handle]
+
+---
+
+_(Add more journeys as needed — every core flow gets its own journey)_
+
+---
+
+## 3. Business Rules
+
+> Explicit rules that govern behavior. If it's not here, it doesn't exist.
+
+### [Entity/Feature] Rules
+
+1. **[Rule name]:** [Description]
+2. **[Rule name]:** [Description]
+
+### Validation Rules
+
+| Entity | Field | Rule |
+|--------|-------|------|
+| | | |
+
+### Automatic Calculations
+
+| When | Calculate | Formula/Logic |
+|------|-----------|---------------|
+| | | |
+
+### Notifications/Triggers
+
+| Event | Action | Recipients |
+|-------|--------|------------|
+| | | |
+
+---
+
+## 4. Permissions Matrix
+
+> Who can CRUD what, under what conditions.
+
+| Entity | Create | Read | Update | Delete |
+|--------|--------|------|--------|--------|
+| | | | | |
+
+_Conditions (e.g., "owner only when status = draft") documented per cell._
+
+---
+
+## 5. Edge Cases & Error Handling
+
+| Scenario | Handling |
+|----------|----------|
+| User submits invalid data | |
+| Network connection lost | |
+| Concurrent edit conflict | |
+| External service down | |
+| User tries unauthorized action | |
+
+---
+
+## 6. Design Decisions & Overrides
+
+> Intentional deviations from framework UX heuristics (3-click rule, 70/30 hierarchy).
+> **FOR AGENTS:** If documented here, do NOT challenge during Build or Polish phases.
+
+| Target (Page/Feature) | Override Description | Rationale |
+|-----------------------|----------------------|-----------|
+| | | |
+
+---
+
+## Validation Checklist
+
+- [ ] Every user journey has 5+ numbered steps
+- [ ] Every business rule is explicit (not implied)
+- [ ] Every entity has CRUD permissions for every role
+- [ ] Can answer "what happens when Z fails?" for common scenarios
+- [ ] No "TBD", "TODO", or empty fields
+- [ ] User has reviewed and confirmed this document