Skip to content

Commit 83bb788

Browse files
committed
docs(tracking): update roadmap with docs site progress
1 parent 5118c2c commit 83bb788

2 files changed

Lines changed: 18 additions & 6 deletions

File tree

docs/CURRENT.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
11
# Current: Live Working State
22

33
## Working
4+
- Phase 5D: Documentation site infrastructure — VitePress + phpDocumentor hybrid, GitHub Actions deploy to docs.saltus.dev, @api annotations on 84 public classes/interfaces, doc content pages @since 2026-07-21
45
- Phase 5A: Block Editor integration — Blocks feature service, per-CPT block registration, default templates @since 2026-07-08
5-
- Phase 5D: Documentation — fill README placeholders, add model examples @since 2026-07-05
6-
- MCP/REST gating refactor: McpPolicy + config-section model @since 2026-07-08
6+
- Phase 4F/4G: AbilityRuntime middleware pipeline integration — backward-compatible pipeline delegation added to execute() @since 2026-07-21
77

88
## Next
9+
- Phase 5D: Fill remaining README placeholders (features, labels, meta, settings tables)
10+
- Phase 5D: Create BLOCKS.md, WPCLI.md, FRONTEND.md content pages
11+
- Phase 5D: Create bin/generate-wpcli-docs.php doc generator
912
- Phase 5B: WP-CLI tools — 7 grouped command classes mapping every MCP tool
1013
- Phase 5C: Frontend rendering — shortcodes, templates, meta field exposure
11-
- Phase 5D: New doc files (BLOCKS.md, WPCLI.md, FRONTEND.md, FEATURES.md)
1214

1315
## Blocked
1416
- None
1517

1618
## Recent Changes
19+
- Docs infrastructure: VitePress site scaffolded at `docs/.vitepress/`, phpDocumentor config at `phpdoc.dist.xml`, `.github/workflows/docs.yml` for auto-build + GH Pages deploy to `docs.saltus.dev`, `docs/public/CNAME` for custom domain, 6 doc content pages (getting-started, features, architecture, build, MCP overview, API index), `composer docs:all` script (`docs:mcp` + `docs:api`), @api annotations on 84 public classes/interfaces across all namespaces, README updated with docs.saltus.dev links, ROADMAP.md Phase 5D progress tracked @since 2026-07-21
20+
- AbilityRuntime middleware pipeline integration: backward-compatible `execute_via_pipeline()` delegated from `execute()`, `execute_legacy()` preserved as fallback, optional `MiddlewarePipeline` constructor injection — resolves Phase 4F/4G strip-cache/strip-rate-limit items @since 2026-07-21
1721
- Code review feedback: replaced wp_die with RuntimeException in single_export_query to avoid HTML death pages in REST/MCP contexts; added catch clause in export_post to return structured WP_Error; replaced unsafe property_exists with get_object_vars in ModelRestPolicy to avoid fatal errors on non-public properties; added explicit edit_posts permission checks for list_models/get_model/list_meta_fields/get_meta_fields in AbilityDefinitionFactory; changed AuditLogger created_at column from varchar(32) to datetime(3) — 2 commits @since 2026-07-04
1822
- Export query hardening: replaced fragile string-equality check in single_export_query with structural regex detection via is_fake_date_export_query; added wp_die fallback for unrecognized fake-date query shapes; added esc_html__ and wp_die test stubs — 1 commit @since 2026-07-04
1923
- Code review feedback: deferred RestServer instantiation inside rest_api_init to avoid overhead on non-REST requests; replaced wp_next_scheduled/wp_unschedule_event with wp_clear_scheduled_hook in MCP deactivation; gated ensure_table() behind DB version option to avoid unnecessary CREATE TABLE queries on every audit write; added wp_clear_scheduled_hook test stub — 3 commits @since 2026-07-04

docs/ROADMAP.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Expose Saltus Framework capabilities through WordPress-native MCP/Abilities. Sal
152152
| **Docker image** | Skipped with standalone server path |
153153
| **GitHub Action** | Skipped with standalone server path |
154154
| **VS Code extension** | Future WordPress-native MCP client integration |
155-
| **Documentation site** | Source pages added at `docs/MCP.md`, `docs/MCP-CLIENTS.md`, and generated `docs/MCP-ABILITIES.md` for future `docs.saltus.dev/mcp` |
155+
| **Documentation site** | VitePress site live at `docs.saltus.dev`, phpDocumentor API docs, GitHub Actions auto-deploy, MCP docs integrated |
156156
| **MCP Registry listing** | Reassess for WordPress-native abilities |
157157
| **Support & SLA model** | Paid support contracts, custom tool development |
158158

@@ -358,8 +358,16 @@ frontend:
358358
359359
**Auto-generation:** `composer docs:wpcli` script in `bin/generate-wpcli-docs.php` to generate WP-CLI command tables (parallel to `bin/generate-mcp-docs.php`).
360360
361+
**Docs site infrastructure (new):** VitePress static site at `docs.saltus.dev` + phpDocumentor API docs + GitHub Actions auto-deploy.
362+
361363
| Item | Status |
362364
|------|--------|
365+
| VitePress site config + landing page | ✓ Done |
366+
| phpDocumentor config (phpdoc.dist.xml) | ✓ Done |
367+
| @api annotations on 84 public classes/interfaces | ✓ Done |
368+
| GitHub Actions workflow (build + deploy to Pages) | ✓ Done |
369+
| Docs content: getting-started, architecture, build, features, MCP | ✓ Done |
370+
| `composer docs:all` script (mcp + api) | ✓ Done |
363371
| README features table | ○ Pending |
364372
| README labels reference | ○ Pending |
365373
| README meta structure | ○ Pending |
@@ -372,11 +380,11 @@ frontend:
372380
| docs/FEATURES.md | ○ Pending |
373381
| bin/generate-wpcli-docs.php | ○ Pending |
374382
375-
**Exit criteria:** Zero `(More Info Soon)` or `(Soon)` placeholders in README. All four new features have dedicated doc files. Feature reference is extracted to `docs/FEATURES.md`. WP-CLI docs are auto-generated.
383+
**Exit criteria:** `(More Info Soon)` placeholders filled, docs.saltus.dev live with VitePress + API docs, auto-deploy via GitHub Actions. All four feature doc files created. WP-CLI docs auto-generated.
376384
377385
---
378386
379-
*Plugin Generator moved to its own repository — see [docs/PLUGIN_GENERATOR_ROADMAP.md](./PLUGIN_GENERATOR_ROADMAP.md).*
387+
*Plugin Generator moved to its own repository — see the [framework-demo repository](https://github.com/SaltusDev/framework-demo).*
380388
381389
## Framework Core Roadmap
382390

0 commit comments

Comments
 (0)