From 1d84953f18fc1d300cb93d75a79a87e745bdf885 Mon Sep 17 00:00:00 2001 From: Travis James Date: Sat, 26 Sep 2026 01:01:12 -0500 Subject: [PATCH 1/3] docs: plan UI routing documentation refresh Assisted-by: Codex:GPT-6 [OpenSpec, Git] --- .../.openspec.yaml | 3 ++ .../ui-ux-documentation-refresh/design.md | 29 +++++++++++++++++++ .../ui-ux-documentation-refresh/proposal.md | 24 +++++++++++++++ .../ui-ux-documentation-refresh/tasks.md | 10 +++++++ 4 files changed, 66 insertions(+) create mode 100644 openspec/changes/ui-ux-documentation-refresh/.openspec.yaml create mode 100644 openspec/changes/ui-ux-documentation-refresh/design.md create mode 100644 openspec/changes/ui-ux-documentation-refresh/proposal.md create mode 100644 openspec/changes/ui-ux-documentation-refresh/tasks.md diff --git a/openspec/changes/ui-ux-documentation-refresh/.openspec.yaml b/openspec/changes/ui-ux-documentation-refresh/.openspec.yaml new file mode 100644 index 00000000..baf10909 --- /dev/null +++ b/openspec/changes/ui-ux-documentation-refresh/.openspec.yaml @@ -0,0 +1,3 @@ +schema: spec-driven +created: 2026-09-26 +skip_specs: true diff --git a/openspec/changes/ui-ux-documentation-refresh/design.md b/openspec/changes/ui-ux-documentation-refresh/design.md new file mode 100644 index 00000000..d3be8b51 --- /dev/null +++ b/openspec/changes/ui-ux-documentation-refresh/design.md @@ -0,0 +1,29 @@ +## Context + +See proposal.md. The implementation PRs are merged: full pack #102, mini #3 and The Boss #4. Each documentation branch starts at current main in the existing isolated checkout. Full and mini own Docusaurus sources; The Boss owns Markdown reference/contributor docs and a generated index. + +## Goals / Non-Goals + +**Goals:** Readers can discover the new workflow from each README, follow source-accurate instructions and distinguish bundled functionality from deferred ports and execution gaps. The Boss uses its existing official logo and name. + +**Non-Goals:** No runtime or skill behavior changes, dependency or submodule upgrades, new website platform, redeployment, blanket upstream/API renaming, or renewed platform certification. + +## Decisions + +- One production documentation owner per repository, with disjoint paths; root owns this plan, final validation, commits and PR publication. This follows the repository team policy and preserves independent authoring without shared-file edits. +- Hand-author narrative at existing documentation sources and run the existing index/catalog generators. Do not edit generated copies directly. +- Treat runtime source and pinned catalog as factual authority. Describe 41 full UI catalog entries / 40 portable entries separately from total distributed skill counts. Avoid global claims based on older foundation tests. +- Keep project design authority, role permissions and user-only skill restrictions explicit. The phase-boundary helper reports an evidence contract; it does not perform captures or independently certify review. +- The Boss logo must be an inspected, tracked product asset, referenced locally. Replace upstream product marketing and links with verified The Boss destinations; retain legal attribution and existing technical identifiers. +- Finish every production documentation edit before local site builds and documentation checks. Validate through the actual documentation production pipeline, then do one independent whole-change review and bounded corrections if needed. Do not poll or cite hosted test workflows. + +## Risks / Trade-offs + +- Generated catalog pages can expose pre-existing MDX or link defects → use existing generators and fix only defects that block the requested documentation output; disclose unrelated limitations. +- Docs may imply release availability → say merged source/build integration unless published binary evidence specifically establishes availability. +- Upstream branding appears in API names and legal notices → limit renaming to product-facing prose and preserve provenance. +- Separate repositories drift → use the same workflow/compatibility distinctions and cross-link the companion guides and PRs. + +## Migration Plan + +Create one new documentation PR per repository against main after local validation. No deployment is performed. Each documentation commit can be reverted independently. diff --git a/openspec/changes/ui-ux-documentation-refresh/proposal.md b/openspec/changes/ui-ux-documentation-refresh/proposal.md new file mode 100644 index 00000000..44ff6fdb --- /dev/null +++ b/openspec/changes/ui-ux-documentation-refresh/proposal.md @@ -0,0 +1,24 @@ +## Why + +The UI/UX routing and team-adoption implementation is merged across the full pack, mini pack and The Boss, but entrypoint documentation and documentation sites do not yet explain the shipped workflows. The Boss README still presents upstream Cherry Studio branding instead of its existing official identity. + +## What Changes + +- Refresh each repository README and its relevant guides/navigation/generated documentation to describe the merged implementation accurately. +- Document routing, platform selection, safe project installation, team defaults, full/mini portability, packaged helpers and remaining acceptance gaps. +- Use The Boss's real checked-in logo and product branding in its README; preserve upstream attribution, licensing and technical identifiers. +- Validate locally after all documentation edits, then create one documentation-only PR per repository. + +## Capabilities + +### New Capabilities + +None. This documentation-only change uses skip_specs: true. + +### Modified Capabilities + +None. Runtime behavior, dependency pins, installed product releases and platform certification are unchanged. + +## Impact + +README.md, docs and Docusaurus content/navigation in the full and mini packs; README.md, documentation source metadata and generated docs index in The Boss. Existing documentation generators remain authoritative. No new runtime, service or public API. diff --git a/openspec/changes/ui-ux-documentation-refresh/tasks.md b/openspec/changes/ui-ux-documentation-refresh/tasks.md new file mode 100644 index 00000000..62b06c56 --- /dev/null +++ b/openspec/changes/ui-ux-documentation-refresh/tasks.md @@ -0,0 +1,10 @@ +## 1. Documentation production + +- [ ] 1.1 Refresh full-pack README, guides and Docusaurus navigation/catalog sources; verify rendered output at the final documentation gate. +- [ ] 1.2 Refresh mini README, guides and Docusaurus navigation/catalog sources; verify rendered output and portable-command accuracy at the final documentation gate. +- [ ] 1.3 Refresh The Boss README using the inspected official logo, correct product branding, update guides and regenerate its documentation index; verify local asset/link rendering and docs checks at the final gate. + +## 2. Completed documentation boundary + +- [ ] 2.1 Run local production documentation builds/checks and independent review after all edits; record results and fix blocking documentation defects in one batch. +- [ ] 2.2 Commit and push only scoped documentation changes and create three linked, non-draft documentation PRs; verify their URLs, bases and changed-file scope without using hosted test workflows as evidence. From f5a7c2eb4fcd15a85021a76a887c9d07516b0f1e Mon Sep 17 00:00:00 2001 From: Travis James Date: Sat, 26 Sep 2026 01:27:21 -0500 Subject: [PATCH 2/3] docs: explain portable UI routing and project team adoption Assisted-by: Codex:GPT-6 [Git, OpenSpec, Node.js, Playwright] --- README.md | 85 ++++---- docs/agent-teams.md | 87 +++++++- docs/ui-ux-routing.md | 197 +++++++++++++++++ .../ui-ux-documentation-refresh/tasks.md | 8 +- .../verification.md | 22 ++ site/docs/agent-teams/overview.md | 83 ++++++- .../context/prometheus-context-bootstrap.md | 23 +- site/docs/distribution/plugin-marketplace.md | 13 +- site/docs/getting-started/installation.md | 13 +- site/docs/intro.md | 32 +-- site/docs/platform/windows-constraints.md | 11 + .../reference/comparison-with-full-pack.md | 48 +++-- site/docs/ui-ux/overview.md | 202 ++++++++++++++++++ site/scripts/generate-skills-catalog.mjs | 13 +- site/sidebars.js | 5 + 15 files changed, 749 insertions(+), 93 deletions(-) create mode 100644 docs/ui-ux-routing.md create mode 100644 openspec/changes/ui-ux-documentation-refresh/verification.md create mode 100644 site/docs/ui-ux/overview.md diff --git a/README.md b/README.md index e6498600..d1eed402 100644 --- a/README.md +++ b/README.md @@ -18,36 +18,31 @@ available. On Windows both run in **Docker**; on macOS and Linux they run exactly as they do in the source pack today. Everything else that was a daemon is gone. -> **Status: the foundation is built and verified; the KBD lifecycle, adversarial review, -> ideation-mindmap, Karpathy progress memory, plugin distribution, and the Docker services -> are ported and real.** +> **Current inventory: 97 distributed skills, including 40 portable UI/UX entries.** +> The shared full/mini catalog has 41 UI/UX entries; its full-only Impeccable native engine +> is excluded from mini. Mini ships the bounded `prometheus-impeccable-core` adaptation, +> shared UI routing and review, TypeScript 7/Node Pro Max, and automatic project-team adoption. > -> Phase `platform-foundation` is complete: `lib/platform/` (paths, CRLF-tolerant text -> reading, atomic write with a bounded Windows rename retry, an exclusive-create lock, -> shell-free process spawning), a `package.json` with the OpenSpec CLI pinned, and a -> three-OS CI matrix. **88 tests pass on `windows-latest`, `ubuntu-latest` and -> `macos-latest` across Node 22 and 24, with nothing skipped on Windows** — every Windows -> claim about that phase is observed, not reasoned from macOS. Per-claim evidence: -> [`evidence/windows.md`](.kbd-orchestrator/phases/platform-foundation/evidence/windows.md). -> -> A later phase ("port the KBD process orchestrator and 49 skills to Windows-native Node") -> closed the gap this section used to describe as not-yet-started: **53 skills** now live -> under `skills/`, including the full 24-skill KBD family (`kbd-process-orchestrator` plus -> 22 sub-skills, `kbd-evolve`, `kbd-goal-check`), `adversarial-review`, `ideation-mindmap`, -> `karpathy-progress-memory`, 20 artifact-refiner skills, 5 scaffold/convert skills, and the -> plugin/marketplace distribution generator (`lib/distribution/`, `skill-system.json`). -> **1,000+ tests pass**, `docker/compose.yaml` runs SurrealDB + surreal-memory + liter-llm -> as three loopback-bound, digest-pinned containers, and `scripts/services.mjs` wraps their -> lifecycle. **Windows verification for this later batch is still owed** — it ran on macOS -> only, the same caveat recorded for every phase before it; `platform-foundation`'s own -> Windows claims remain the ones with real CI evidence. See the -> [Docusaurus site](#documentation-site) for full-coverage documentation of every skill and -> `lib/` module, and [`docs/reference/comparison-with-full-pack`](site/docs/reference/comparison-with-full-pack.md) -> for what remains a genuine gap versus what was always a deliberate exclusion. -> -> Still open: `deep-research` (planned as a checkpoint-only Node port; not yet a skill in -> this checkout), the knowledge-sources registry, and Windows hardware verification of the -> Docker services and the Phase C skill batch. +> The KBD lifecycle, adversarial review, Karpathy progress memory and plugin distribution +> are implemented. Verification belongs to a specific phase and environment: the historical +> [platform-foundation Windows evidence](.kbd-orchestrator/phases/platform-foundation/evidence/windows.md) +> does not certify later UI/team work. The [UI/team delivery record](docs/research/ui-ux-routing/DELIVERY.md) +> records macOS and offline Linux-container integration evidence. Native Windows execution, +> live invocation of every harness and full Electron installed-app acceptance remain unverified. +> This documentation does not claim release certification. + +## UI/UX routing + +Use `prometheus-ui-ux` for rendered UI, styles, tokens, interaction, motion or on-screen copy. +Read project context first; `.agents/UI_UX_PROTOCOL.md` overrides the bundled protocol. +The router chooses a focused Pro Max query, one craft skill and relevant platform guidance. +New work may use taste based on the **actual model**; refinement and review exclude taste. +Completed UI phases use independent `prometheus-ui-review` with real evidence. Upstream +`interface-review`, `break`, `variant` and `explain-interface` remain user-only. + +Start with the [UI/UX routing how-to](docs/ui-ux-routing.md), including project installation, +request examples, platform limits, offline use and troubleshooting. Helpers ship as Node ESM; +no Python, engine download, extra service or runtime dependency installation is needed. ## Agent teams @@ -59,8 +54,14 @@ producing an editable manifest. The shared full/mini runtime stages native artifacts for **UAR, Codex, Claude Code, GitHub Copilot CLI, Kimi Code, MiniMax CLI (`mcode`), OpenCode, and DeepSeek Harness**. **BossFang** -is a separate registration/export target. Export does not install agents, register services, -or launch teams. Native options retain source/version provenance and explicit limitations. +is a separate registration/export target. Export stages proposals. Normal project-team creation continues with `install-project`, which +installs discovery instructions and missing native project definitions. Neither operation launches +agents or registers services. Native options retain source/version provenance and explicit limitations. + +For all code tasks, preserve the explicit active team; adopt a sole existing team, and ask when +several remain ambiguous. Use relevant roles with their existing ownership and native permissions. +When delegation is unavailable, use role instructions sequentially and disclose that limit. Zed +instruction discovery is supported; its parallel-thread UI is not a delegation API. Task state uses revision checks and local atomic writes; cross-harness handoffs transfer ownership only after acceptance. Model selection uses declared tiers and explicit price @@ -85,7 +86,8 @@ conversion, plugin distribution, Docker services, and OpenSpec integration — i ```bash cd site -npm install +npm ci +npm run generate:catalog npm start ``` @@ -100,7 +102,7 @@ that touches `site/`, `docs/`, or any `skills/**/SKILL.md` — the same build | # | Constraint | What it means in practice | |---|---|---| -| C1 | **Windows without WSL for anything the pack runs** | Hooks, scripts, and the installer run from `cmd.exe` / PowerShell on a stock Windows 10/11 box. Git Bash may be present but is never required. Docker's own backend is the one exception — see the note below the table. **Verified for everything built so far** on `windows-latest`, no Git Bash, no WSL. | +| C1 | **Windows without WSL for anything the pack runs** | Hooks, scripts, and the installer run from `cmd.exe` / PowerShell on a stock Windows 10/11 box. Git Bash may be present but is never required. Docker's own backend is the one exception — see the note below the table. Historical Windows evidence covers `platform-foundation`; later UI/team native Windows acceptance remains open. | | C2 | **Node.js LTS is the only script runtime** | Every hook, state script, and installer is a `.mjs` file run as `node