LearnNewsExamplesServices
Frontmatter
id15179
titleDocument fresh-checkout theme build in showcase app READMEs
stateClosed
labels
documentationenhancementdeveloper-experienceai
assigneesneo-gpt-emmy
createdAtJul 14, 2026, 7:57 PM
updatedAtJul 14, 2026, 10:09 PM
githubUrlhttps://github.com/neomjs/neo/issues/15179
authorneo-opus-vega
commentsCount0
parentIssuenull
subIssues[]
subIssuesCompleted0
subIssuesTotal0
contentTrust
projected
quarantined0
signals[]
blockedBy[]
blocking[]
closedAtJul 14, 2026, 10:09 PM
milestonev13.2

Document fresh-checkout theme build in showcase app READMEs

Closed Backlog/active-chunk-6 documentationenhancementdeveloper-experienceai
neo-opus-vega
neo-opus-vega commented on Jul 14, 2026, 7:57 PM

Context

Surfaced during the cross-family review of PR #15177 (Approve+Follow-Up). #15177 closes #14589's "builds and runs from a fresh checkout with documented steps" AC by adding the non-interactive theme-build step to apps/agentos/childapps/dockdemo/README.md. A review V-B-A of the sibling showcase apps found the flagship carries the identical gap, so the fresh-checkout story is only half-fixed.

The Problem

apps/workstation/README.md (the standalone flagship Workstation delivered in #15146) documents its run sequence as:

npm install
npm run server-start

It omits the theme build. Because apps/** development CSS and resources/theme-map.json are gitignored generated artifacts, a fresh clone that follows this README literally boots the app without styles / theme registration — a broken first impression on the app most central to the reach funnel. This is exactly the fresh-checkout DX failure #14589 raised for the dock demos, still live for the flagship (and possibly other apps/** READMEs that document a run sequence).

The Architectural Reality

  • apps/** .css / neo-config / theme-map.json artifacts are ignored by default (new-app gitignore whitelist pattern); they are produced by the theme build, not committed.
  • The verified non-interactive command is npm run build-themes -- -n -e dev -t all (-n non-interactive, -e dev dev env, -t all all themes) — run repeatedly and green across #15170 / #15175 / #15176 / #15177, generating the dev theme files and registering apps in resources/theme-map.json.
  • apps/workstation/README.md:12-13 is the two-command sequence missing the build step. #15177 established the correct three-command pattern for dockdemo; this ticket propagates that shipped pattern.

The Fix

  1. Add the npm run build-themes -- -n -e dev -t all step (between npm install and npm run server-start) plus the "creates the ignored development CSS and theme-map.json a fresh checkout does not contain" note to apps/workstation/README.md, mirroring #15177's dockdemo fix verbatim.
  2. Audit the remaining apps/**/README.md files that document a npm install / npm run server-start sequence; apply the same three-command pattern where the step is missing, or confirm N/A.

Decision Record impact

none — documentation only; no code, config, or persisted/runtime surface changes.

Acceptance Criteria

  • apps/workstation/README.md documents the non-interactive theme build step and the ignored-artifacts note.
  • Every other apps/**/README.md that documents a run sequence is audited and either fixed to the three-command pattern or explicitly confirmed N/A.
  • A fresh clone following each fixed README produces a themed, running app (post-merge spot check).

Out of Scope

  • Auto-building themes via an install/postinstall hook (a larger DX change; a separate ticket if pursued).
  • Changing the build-themes command surface or the apps/** gitignore whitelist.
  • Non-README documentation.

Avoided Traps

  • Do not centralize-vs-duplicate reflexively: matching the shipped #15177 per-README pattern is the minimal consistent fix now; a shared "running an app" doc is a legitimate alternative but should be a deliberate call, not an accident of this fix.
  • Do not commit the generated theme artifacts to "solve" it — they are intentionally gitignored.

Related

Follow-up from PR #15177 review · #14589 (dock-demo fresh-checkout closure) · #15146 (standalone Workstation) · #13158 (QT-docking epic)

Origin Session ID: a8b22c4c-dc82-440e-a8fb-95570036aa4e

Retrieval Hint: fresh checkout theme build README build-themes non-interactive apps workstation dockdemo theme-map

Authored by Vega (Claude Opus 4.8, Claude Code). Filed as the Approve+Follow-Up artifact of the PR #15177 cross-family review; unassigned for peer self-select (reviewer is review-only this cycle).

tobiu referenced in commit b713631 - "docs(workstation): document fresh-checkout theme build (#15179) (#15181)" on Jul 14, 2026, 10:09 PM
tobiu closed this issue on Jul 14, 2026, 10:09 PM