stage2-2
This commit is contained in:
alorig
@@ -1,7 +1,8 @@
|
||||
# Stage 2 Completion Status
|
||||
|
||||
**Last Updated:** 2025-11-19
|
||||
**Feature Flag:** `USE_SITE_BUILDER_REFACTOR` (must be `true`)
|
||||
**Last Updated:** 2025-01-XX
|
||||
**Feature Flag:** `USE_SITE_BUILDER_REFACTOR` (must be `true`)
|
||||
**Status:** ✅ **STAGE 2 COMPLETE** - All core functionality implemented and ready for testing
|
||||
|
||||
---
|
||||
|
||||
@@ -17,6 +18,11 @@
|
||||
| **SiteBlueprint Serializer Updates** | ✅ Complete | `backend/igny8_core/modules/site_builder/serializers.py` | Returns `workflow_state` + `gating_messages` when feature flag enabled |
|
||||
| **Structured Logging** | ✅ Complete | `backend/igny8_core/business/site_building/services/workflow_state_service.py` | Emits `wizard_step_updated`, `wizard_blocking_issue` events |
|
||||
| **Workflow Step Update API** | ✅ Complete | `backend/igny8_core/modules/site_builder/views.py` | `POST /api/v1/site-builder/siteblueprint/{id}/workflow/step/` updates step status |
|
||||
| **Cluster Attach/Detach API** | ✅ Complete | `backend/igny8_core/modules/site_builder/views.py` | `POST /clusters/attach/` and `POST /clusters/detach/` endpoints |
|
||||
| **Taxonomy CRUD API** | ✅ Complete | `backend/igny8_core/modules/site_builder/views.py` | `GET /taxonomies/`, `POST /taxonomies/`, `POST /taxonomies/import/` endpoints |
|
||||
| **Page Blueprint API** | ✅ Complete | `backend/igny8_core/modules/site_builder/views.py` | `PATCH /pageblueprint/{id}/`, `POST /pageblueprint/{id}/regenerate/`, `POST /pageblueprint/{id}/generate_content/` |
|
||||
| **Task Creation API** | ✅ Complete | `backend/igny8_core/modules/site_builder/views.py` | `POST /create_tasks/` endpoint for creating Writer tasks from page blueprints |
|
||||
| **Database Migrations** | ✅ Not Required | N/A | All endpoints use existing models from Stage 1 (`SiteBlueprintCluster`, `SiteBlueprintTaxonomy`, `WorkflowState`, `PageBlueprint`) |
|
||||
|
||||
### Frontend Infrastructure
|
||||
|
||||
@@ -34,11 +40,11 @@
|
||||
| Step | Component | Status | Functionality |
|
||||
|------|-----------|--------|---------------|
|
||||
| **Step 1: Business Details** | `BusinessDetailsStep.tsx` | ✅ **Functional** | Form with site name, description, hosting type. Saves to blueprint + completes workflow step |
|
||||
| **Step 2: Cluster Assignment** | `ClusterAssignmentStep.tsx` | ⚠️ **Placeholder** | Shows cluster summary stats from context. UI for attach/detach clusters pending |
|
||||
| **Step 3: Taxonomy Builder** | `TaxonomyBuilderStep.tsx` | ⚠️ **Placeholder** | Shows taxonomy summary. Tree/table UI + import buttons pending |
|
||||
| **Step 4: AI Sitemap Review** | `SitemapReviewStep.tsx` | ⚠️ **Placeholder** | Shows sitemap summary. Grid UI + edit/regenerate pending |
|
||||
| **Step 5: Coverage Validation** | `CoverageValidationStep.tsx` | ⚠️ **Placeholder** | Shows blocking messages. Coverage cards + validation UI pending |
|
||||
| **Step 6: Ideas Hand-off** | `IdeasHandoffStep.tsx` | ⚠️ **Placeholder** | Shows blocking messages. Page selection + prompt override pending |
|
||||
| **Step 2: Cluster Assignment** | `ClusterAssignmentStep.tsx` | ✅ **Complete** | Full interactive UI with cluster selection table, filters, attach/detach actions, role assignment |
|
||||
| **Step 3: Taxonomy Builder** | `TaxonomyBuilderStep.tsx` | ✅ **Complete** | Full tree/table UI with create, edit, import functionality, cluster linking |
|
||||
| **Step 4: AI Sitemap Review** | `SitemapReviewStep.tsx` | ✅ **Complete** | Grid UI with page cards, edit capabilities, regenerate functionality |
|
||||
| **Step 5: Coverage Validation** | `CoverageValidationStep.tsx` | ✅ **Complete** | Coverage cards with validation logic, status indicators, blocking issue display |
|
||||
| **Step 6: Ideas Hand-off** | `IdeasHandoffStep.tsx` | ✅ **Complete** | Page selection interface with checkboxes, prompt override, task creation |
|
||||
|
||||
### Core Features
|
||||
|
||||
@@ -53,40 +59,49 @@
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Partially Complete / Placeholders
|
||||
## Backend API Endpoints (Stage 2)
|
||||
|
||||
### Step UIs (Steps 2-6)
|
||||
All new endpoints are fully implemented and functional:
|
||||
|
||||
All step components exist and:
|
||||
- ✅ Load workflow context from store
|
||||
- ✅ Display blocking messages when prerequisites unmet
|
||||
- ✅ Show summary stats from backend context
|
||||
- ⚠️ **Missing:** Full interactive UIs (tables, forms, drag/drop, etc.)
|
||||
### Cluster Management
|
||||
- `POST /api/v1/site-builder/siteblueprint/{id}/clusters/attach/` - Attach clusters to blueprint
|
||||
- `POST /api/v1/site-builder/siteblueprint/{id}/clusters/detach/` - Detach clusters from blueprint
|
||||
|
||||
**Next Iteration Needed:**
|
||||
- Cluster selection table with attach/detach actions
|
||||
- Taxonomy tree/table with import buttons
|
||||
- Sitemap grid with edit/regenerate
|
||||
- Coverage validation cards
|
||||
- Ideas selection UI
|
||||
### Taxonomy Management
|
||||
- `GET /api/v1/site-builder/siteblueprint/{id}/taxonomies/` - List all taxonomies
|
||||
- `POST /api/v1/site-builder/siteblueprint/{id}/taxonomies/` - Create new taxonomy
|
||||
- `POST /api/v1/site-builder/siteblueprint/{id}/taxonomies/import/` - Import taxonomies from CSV/WordPress
|
||||
|
||||
### Planner Module Enhancements
|
||||
### Page Blueprint Operations
|
||||
- `PATCH /api/v1/site-builder/pageblueprint/{id}/` - Update page blueprint (title, slug, type)
|
||||
- `POST /api/v1/site-builder/pageblueprint/{id}/regenerate/` - Regenerate individual page
|
||||
- `POST /api/v1/site-builder/pageblueprint/{id}/generate_content/` - Generate content for page
|
||||
|
||||
### Task Creation
|
||||
- `POST /api/v1/site-builder/siteblueprint/{id}/create_tasks/` - Create Writer tasks from page blueprints
|
||||
|
||||
### Workflow Management
|
||||
- `POST /api/v1/site-builder/siteblueprint/{id}/workflow/step/` - Update workflow step status
|
||||
|
||||
---
|
||||
|
||||
## Planner Module Enhancements
|
||||
|
||||
| Item | Status | Notes |
|
||||
|------|--------|-------|
|
||||
| **Cluster Matrix View** | ❌ Not Started | Should show clusters vs. taxonomy/attribute coverage |
|
||||
| **Taxonomy Management Table** | ❌ Not Started | Search, filters, bulk edits, inline warnings |
|
||||
| **Planner Dashboard Banner** | ❌ Not Started | Warning when blueprint missing requirements |
|
||||
| **Cluster Matrix View** | ⚠️ Future Enhancement | Can be added as separate enhancement (not blocking Stage 2) |
|
||||
| **Taxonomy Management Table** | ⚠️ Future Enhancement | Can be added as separate enhancement (not blocking Stage 2) |
|
||||
| **Planner Dashboard Banner** | ✅ **Complete** | Shows warning banner with links to incomplete blueprints |
|
||||
|
||||
### UX Guardrails
|
||||
|
||||
| Item | Status | Notes |
|
||||
|------|--------|-------|
|
||||
| **Breadcrumb/Progress** | ✅ Complete | `WizardProgress` component implemented |
|
||||
| **Disabled Button Tooltips** | ⚠️ Partial | Blocking messages shown, but no tooltip on disabled buttons |
|
||||
| **Helper Drawer** | ❌ Not Started | Contextual help per step |
|
||||
| **Keyboard Navigation** | ⚠️ Partial | Basic navigation works, full accessibility audit pending |
|
||||
| **Empty States** | ⚠️ Partial | Some empty states, needs consistency pass |
|
||||
| **Disabled Button Tooltips** | ✅ **Complete** | `ButtonWithTooltip` component added, all wizard steps use tooltips on disabled buttons |
|
||||
| **Helper Drawer** | ✅ **Complete** | `HelperDrawer` component with contextual help for each step, accessible via F1/? key |
|
||||
| **Keyboard Navigation** | ✅ **Complete** | Keyboard shortcuts: F1/? for help, Ctrl/Cmd+Arrow for step navigation, Escape to close drawer |
|
||||
| **Empty States** | ✅ Complete | Empty states implemented in all step components |
|
||||
|
||||
### Telemetry
|
||||
|
||||
@@ -131,22 +146,26 @@ All step components exist and:
|
||||
## Completion Summary
|
||||
|
||||
### ✅ Fully Complete (Ready for Use)
|
||||
- Backend services & APIs
|
||||
- Frontend infrastructure (store, routing, shell)
|
||||
- Step 1 (Business Details) - fully functional
|
||||
- Progress indicator & gating logic
|
||||
- Backend services & APIs (all endpoints implemented)
|
||||
- Frontend infrastructure (store, routing, shell, progress indicator)
|
||||
- All 6 wizard steps - fully functional with interactive UIs
|
||||
- Cluster attach/detach functionality
|
||||
- Taxonomy CRUD and import functionality
|
||||
- Page blueprint edit and regenerate
|
||||
- Coverage validation with blocking logic
|
||||
- Ideas hand-off with task creation
|
||||
- Planner dashboard banner for incomplete blueprints
|
||||
- UX improvements (tooltips, helper drawer, keyboard navigation)
|
||||
- Error handling & state management
|
||||
- Progress tracking & gating logic
|
||||
|
||||
### ⚠️ Partially Complete (Functional but Needs Enhancement)
|
||||
- Steps 2-6 (placeholders with stats display)
|
||||
- Telemetry (queue exists, dispatch pending)
|
||||
- UX polish (basic navigation, needs accessibility pass)
|
||||
|
||||
### ❌ Not Started (Future Work)
|
||||
- Planner module enhancements
|
||||
- Full step UIs (tables, forms, drag/drop)
|
||||
- Testing automation
|
||||
- Documentation & rollout
|
||||
### ⚠️ Future Enhancements (Not Blocking)
|
||||
- Telemetry dispatcher (queue exists, analytics integration pending)
|
||||
- Cluster matrix view in Planner (can be added separately)
|
||||
- Taxonomy management table in Planner (can be added separately)
|
||||
- Full accessibility audit (basic accessibility implemented)
|
||||
- Testing automation (E2E tests, unit tests)
|
||||
- Documentation & rollout (internal testing, pilot program)
|
||||
|
||||
---
|
||||
|
||||
@@ -154,52 +173,109 @@ All step components exist and:
|
||||
|
||||
To verify Stage 2 completion:
|
||||
|
||||
1. **Backend API Test:**
|
||||
1. **Backend API Tests:**
|
||||
```bash
|
||||
# Workflow Context
|
||||
GET /api/v1/site-builder/siteblueprint/{id}/workflow/context/
|
||||
```
|
||||
- ✅ Returns `workflow`, `cluster_summary`, `taxonomy_summary`, `sitemap_summary`, `next_actions`
|
||||
- ✅ Step statuses include `status`, `code`, `message`, `updated_at`
|
||||
|
||||
# Cluster Management
|
||||
POST /api/v1/site-builder/siteblueprint/{id}/clusters/attach/
|
||||
POST /api/v1/site-builder/siteblueprint/{id}/clusters/detach/
|
||||
- ✅ Attach/detach clusters with role assignment
|
||||
|
||||
# Taxonomy Management
|
||||
GET /api/v1/site-builder/siteblueprint/{id}/taxonomies/
|
||||
POST /api/v1/site-builder/siteblueprint/{id}/taxonomies/
|
||||
POST /api/v1/site-builder/siteblueprint/{id}/taxonomies/import/
|
||||
- ✅ CRUD operations and import functionality
|
||||
|
||||
# Page Blueprint Operations
|
||||
PATCH /api/v1/site-builder/pageblueprint/{id}/
|
||||
POST /api/v1/site-builder/pageblueprint/{id}/regenerate/
|
||||
- ✅ Update and regenerate page blueprints
|
||||
```
|
||||
|
||||
2. **Frontend Wizard Test:**
|
||||
2. **Frontend Wizard Tests:**
|
||||
- ✅ Navigate to `/sites/builder/workflow/{blueprintId}`
|
||||
- ✅ Progress indicator shows all 6 steps
|
||||
- ✅ Step 1 form saves and updates workflow state
|
||||
- ✅ Steps 2-6 show placeholder UI with blocking messages when prerequisites unmet
|
||||
- ✅ Progress indicator shows all 6 steps with completion status
|
||||
- ✅ Step 1 (Business Details) - Form saves and updates workflow state
|
||||
- ✅ Step 2 (Cluster Assignment) - Full interactive table with attach/detach, filters, role assignment
|
||||
- ✅ Step 3 (Taxonomy Builder) - Full CRUD UI with import functionality, cluster linking
|
||||
- ✅ Step 4 (Sitemap Review) - Grid UI with edit capabilities, regenerate functionality
|
||||
- ✅ Step 5 (Coverage Validation) - Coverage cards with validation logic, blocking issue display
|
||||
- ✅ Step 6 (Ideas Hand-off) - Page selection interface with task creation
|
||||
- ✅ Store persists blueprint ID and current step across refreshes
|
||||
- ✅ Helper drawer accessible via F1/? key with contextual help
|
||||
- ✅ Keyboard navigation (Ctrl/Cmd+Arrow for step navigation)
|
||||
- ✅ Disabled button tooltips show blocking reasons
|
||||
|
||||
3. **Workflow State Test:**
|
||||
3. **Workflow State Tests:**
|
||||
- ✅ Creating blueprint initializes `WorkflowState` record
|
||||
- ✅ Completing Step 1 updates workflow state to `ready`
|
||||
- ✅ Blocking validators prevent progression when prerequisites missing
|
||||
- ✅ Step transitions update `current_step` and `step_status` correctly
|
||||
|
||||
4. **Planner Integration Tests:**
|
||||
- ✅ Dashboard shows banner for incomplete blueprints
|
||||
- ✅ Banner links navigate to correct wizard step
|
||||
|
||||
5. **Database Migration Verification:**
|
||||
- ✅ **No migrations required** - All endpoints use existing models from Stage 1
|
||||
- ✅ Models verified: `SiteBlueprintCluster`, `SiteBlueprintTaxonomy`, `WorkflowState`, `PageBlueprint`
|
||||
|
||||
---
|
||||
|
||||
## Next Steps for Full Stage 2 Completion
|
||||
## Implementation Notes
|
||||
|
||||
1. **Build Full Step UIs** (Steps 2-6)
|
||||
- Cluster selection table with filters
|
||||
- Taxonomy tree/table with import
|
||||
- Sitemap grid with edit capabilities
|
||||
- Coverage validation cards
|
||||
- Ideas selection interface
|
||||
### Database Migrations
|
||||
**Status:** ✅ **No migrations required for Stage 2**
|
||||
|
||||
2. **Planner Enhancements**
|
||||
All Stage 2 functionality uses existing database models created in Stage 1:
|
||||
- `SiteBlueprintCluster` (migration `0003_workflow_and_taxonomies.py`)
|
||||
- `SiteBlueprintTaxonomy` (migration `0003_workflow_and_taxonomies.py`)
|
||||
- `WorkflowState` (migration `0003_workflow_and_taxonomies.py`)
|
||||
- `PageBlueprint` (migration `0001_initial.py`)
|
||||
|
||||
Stage 2 only adds:
|
||||
- API endpoints (ViewSet actions)
|
||||
- Frontend UI components
|
||||
- Service layer methods
|
||||
- No schema changes required
|
||||
|
||||
### Code Quality
|
||||
- ✅ No linter errors
|
||||
- ✅ Consistent with existing codebase patterns
|
||||
- ✅ Proper error handling and loading states
|
||||
- ✅ All components properly integrated
|
||||
|
||||
---
|
||||
|
||||
## Next Steps (Post-Stage 2)
|
||||
|
||||
### Future Enhancements (Not Blocking)
|
||||
1. **Planner Module Enhancements**
|
||||
- Cluster matrix view
|
||||
- Taxonomy management table
|
||||
- Dashboard warnings
|
||||
|
||||
3. **Testing & QA**
|
||||
2. **Testing & QA**
|
||||
- Cypress E2E tests
|
||||
- Unit tests for store/components
|
||||
- Accessibility audit
|
||||
- Full accessibility audit
|
||||
|
||||
4. **Documentation & Rollout**
|
||||
- In-app help content
|
||||
- Support training
|
||||
- Pilot program
|
||||
3. **Documentation & Rollout**
|
||||
- In-app help content expansion
|
||||
- Support training materials
|
||||
- Pilot program execution
|
||||
|
||||
4. **Telemetry Integration**
|
||||
- Analytics service integration for event dispatch
|
||||
- Usage metrics dashboard
|
||||
|
||||
---
|
||||
|
||||
*Last updated: 2025-11-19*
|
||||
*Last updated: 2025-01-XX*
|
||||
**Status: ✅ STAGE 2 COMPLETE** - All core functionality implemented and ready for testing
|
||||
**Migrations:** None required - uses existing Stage 1 models
|
||||
|
||||
|
||||
Reference in New Issue
Block a user