diff --git a/ROADMAP.md b/ROADMAP.md index 1b0244856..461eb020d 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,27 +1,75 @@ -# ๐Ÿ“… Q4 2025 Faust Refactor Roadmap +# ๐Ÿ“… Q4 2025 Headless WordPress Toolkit & Faust Refactor Roadmap -| Sprint | Dates | Focus Areas | Key Deliverables | -|--------|----------------|-----------------------------|-----------------| -| 1 | Oct 7 โ€“ Oct 20 | ๐Ÿ›ค Roadmap + Toolbar (first cut) | - Publish roadmap (internal + OSS)
- Scaffold `@wpengine/hwp-toolbar` package
- Toolbar alpha (Preview + Edit buttons, responsive & accessible)
- Demo app with Toolbar | -| 2 | Oct 21 โ€“ Nov 3 | ๐Ÿ“ Core Packages (iteration 1) | - Scaffold `@wpengine/hwp-template-hierarchy` and `@wpengine/hwp-graphql-client`
- GraphQL client wrapper MVP
- Template Hierarchy MVP (basic post/page rendering) | -| 3 | Nov 4 โ€“ Nov 17 | ๐Ÿ“ฆ Core Packages (iteration 2) | - Publish Template Hierarchy alpha
- Publish GraphQL Client alpha
- Toolbar beta (theming tokens, accessibility improvements)
- Scaffold `@wpengine/hwp-auth`
- Draft: *Getting Started with Faust v2* doc | -| 4 | Nov 18 โ€“ Dec 1 | ๐Ÿ”— Framework Adapter + Utils | - Next.js App Router adapter beta (or Pages router)
- Publish `@wpengine/hwp-utils` package
- Toolbar adds draft/publish toggle
- Migration Guide v1 | -| 5 | Dec 2 โ€“ Dec 15 | ๐Ÿš€ DX + Starter Tooling | - Finalize Toolbar stable (white-label theming)
- Starter CLI: `npx create-faust-app` (Next.js baseline) (or just a template)
- Docs: Migration guide expanded with examples | -| 6 | Dec 16 โ€“ Dec 23 | ๐ŸŽ‰ Release Prep & OSS Launch | - Internal & OSS testing of migration flow
- Publish Next.js adapter stable
- Release Faust Core v4.0 (Next.js baseline)
- Community demo + OSS announcement
- Plan Q1 2026 (Astro + SvelteKit adapters) | +This roadmap reflects updated priorities for Q4 2025, emphasizing QA and GA release of the `wpgraphql-logging` plugin, exposure of existing documentation to the Docs site, and focused development on key Headless WordPress Toolkit packages. + +--- + +## ๐Ÿงญ Strategic Priorities + +1. **QA and GA release of `wpgraphql-logging` plugin** + - Validate and release the plugin before end of November. + - Ensure it meets pre-GA QA standards and integrates cleanly with the Toolkit. + +2. **Developer documentation for the Headless WordPress Toolkit** + - Expose existing `.md` files for the Logging Plugin to the Docs site. + - Improve overall Docs structure to support Toolkit content. + +3. **Focused Toolkit package development** + - Prioritize `@wpengine/hwp-template-hierarchy` and `@wpengine/hwp-auth`. + - Defer additional package work to Q1 2026. + +--- + +## ๐Ÿ—“ Sprint Breakdown + +| Sprint | Dates | Focus Areas | Key Deliverables | +|--------|----------------|---------------------------------------|-----------------| +| **1** | Oct 7 โ€“ Oct 20 | ๐Ÿ›ค Planning + Initial Scaffolds | - Publish updated roadmap (internal + OSS)
- Scaffold `@wpengine/hwp-toolbar` (carryover)
- Demo app updated for internal testing
- Prepare QA environment for `wpgraphql-logging` plugin | +| **2** | Oct 21 โ€“ Nov 3 | โœ… **QA & Validation** | - **Pre-GA testing and validation of `wpgraphql-logging` plugin**
- Track QA results and fix issues for GA
- Integrate initial developer docs for Headless WP Toolkit
- *(Stretch goal)* Validate Toolkit examples function as expected | +| **3** | Nov 4 โ€“ Nov 17 | ๐Ÿ“˜ **Docs Integration & Exposure** | - **Expose existing `wpgraphql-logging` plugin `.md` docs to the public Docs site**
- Continue improving developer docs for the Headless WP Toolkit
- Ensure Docs site structure supports Toolkit and Logging content
- Plan GA release logistics for `wpgraphql-logging` | +| **4** | Nov 18 โ€“ Dec 1 | ๐Ÿš€ **Final QA + GA Release** | - **Final QA pass and GA release of `wpgraphql-logging` plugin** ๐ŸŽ‰
- Begin focused development on `@wpengine/hwp-template-hierarchy` and `@wpengine/hwp-auth` packages
- Internal validation and documentation for these packages | +| **5** | Dec 2 โ€“ Dec 15 | ๐Ÿงฉ **Toolkit Package Development** | - Continue iteration on `@wpengine/hwp-template-hierarchy` and `@wpengine/hwp-auth`
- Internal beta testing of both packages
- Refine Toolkit + Faust integration notes
- Update roadmap and documentation accordingly | +| **6** | Dec 16 โ€“ Dec 23 | ๐ŸŽ‰ **Release Prep & OSS Launch** | - OSS publication of Toolkit-related packages and docs
- Publish Next.js adapter alignment roadmap
- Internal & OSS communication (GA recap + next steps)
- Plan Q1 2026: Astro + SvelteKit adapter expansion | --- ## ๐ŸŽฏ End of Quarter Outcomes -- Core packages available: Template Hierarchy, GraphQL Client, Toolbar -- Framework adapter: Next.js App/Pages Router stable -- CLI tooling + Docs -- DX improvements: starter project generator (`npx create-faust-app`) -- Docs: Getting Started, migration guide, roadmap published + +- โœ… **`wpgraphql-logging` plugin GA release completed** +- ๐Ÿ“˜ **Toolkit developer docs published and integrated into Docs site** +- ๐Ÿงฉ **`@wpengine/hwp-template-hierarchy` and `@wpengine/hwp-auth` packages in beta** +- ๐ŸŒ **Improved developer experience with validated Toolkit integration flow** +- ๐Ÿ—บ **Q1 2026 roadmap prepared for adapter expansion (Astro, SvelteKit)** + +--- + +## ๐Ÿ‘‰ By Dec 23, 2025, Developers Can + +- Use the **GA version of the `wpgraphql-logging` plugin** +- Access **Toolkit documentation directly on the Docs site** +- Integrate **`@wpengine/hwp-template-hierarchy`** and **`@wpengine/hwp-auth`** in projects +- Test and contribute to the growing **Faust + Toolkit ecosystem** + +--- + +## ๐Ÿงพ GA Readiness Checklist (Logging Plugin) + +| Area | Criteria | Owner | Status | +|------|-----------|--------|--------| +| QA Testing | All test cases pass across supported WP + GraphQL versions | QA | ๐Ÿ”„ In progress | +| Docs | `.md` files exposed and verified on Docs site | Docs | โœ… Ready | +| Compatibility | Verified with latest WPGraphQL + Toolkit packages | Eng | ๐Ÿ”„ In progress | +| Release | Tagged on GitHub + WP Updater | Eng | โณ Planned (Sprint 4) | +| Announcement | GA summary and migration notes published | Comms | โณ Planned (Sprint 6) | + +--- + +## ๐Ÿ”ฎ Looking Ahead (Q1 2026 Preview) + +- Expand Headless WordPress Toolkit with **Astro** and **SvelteKit** adapters. +- Continue improving `@wpengine/hwp-template-hierarchy` and `@wpengine/hwp-auth`. +- Broaden Toolkit integration with Faust Core and community examples. --- -## ๐Ÿ‘‰ By Dec 23, 2025, developers can: -- Scaffold a Faust app in minutes -- Use the modular Template Hierarchy + GraphQL Client without boilerplate -- Provide editors a functional Toolbar -- Migrate legacy Faust projects safely +_Last updated: Oct 21, 2025_