Skip to content

Improve spec navigation, local test caching, and release verification - #11

Merged
stevejuma merged 6 commits into
mainfrom
improve-specification-docs-and-release-verification
Oct 13, 2026
Merged

stevejuma merged 6 commits into
mainfrom
improve-specification-docs-and-release-verification

Conversation

@stevejuma

@stevejuma stevejuma commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Make the specification readable in canonical Markdown and Storybook, and route local verification through Turbo so unchanged successful suites can be reused. Also repair the published-package consumer's pnpm policy and the standalone CI startup failure for development Docs acceptance.

  • Split dense specification tables into 172 bounded topic/verification pages. Preserve the original 1,365 requirement IDs, constraints, acceptance details, statuses, and evidence against a captured baseline. Keep familiar chapter paths as landing pages and nest Panels/Problems under Workspace Shell. Preserve the 80-word/four-sentence limits and enforce 400 lines/32,768 bytes per page.
  • Derive metadata-only mirrors, chapter order, breadcrumbs, previous/next, and topic links from SUMMARY.md. Add populated outlines, stable requirement anchors, canonical-link routing, legacy redirects, history, and deployment-subpath handling through a private Docs container. Extend strict mirror, route, coverage, and migration audits; update owning-page pointers and CI-image automation.
  • Route local Storybook builds and repository-level test commands through the bounded Turbo runner. Package unit tests already use Turbo. Cache only successful deterministic results, hash source/configuration/dependency/runtime/argument inputs, support --force, and suppress replayed logs on cache hits. Keep live/native/visual-mutation acceptance uncached and preserve complete raw CI suite commands.
  • Fix the failed Storybook CI job: all 243 interaction/axe tests passed, then development Docs startup failed because it required a missing sibling plugin release manifest. Playwright now starts the existing owned supervisor through storybook:installed, against the installed graph, without preparing sibling artifacts. The focused regression reproduces ENOENT before the fix and passes afterward.
  • Fix release run 38375257253, attempt 2: generate the external npm consumer with the root's exact pnpm packageManager pin and only its approved onlyBuiltDependencies. Do not copy hooks, patches, overrides, or workspace links, and do not blanket-enable scripts.

Eleven new documentation/tooling requirements bring the total to 1,376. Two authoring-format governance changes are recorded separately. Existing product APIs and implementation progress remain unchanged; historical evidence is retained.

Focused validation:

  • Passed final pnpm spec:check with 38 local specification tests, the original-1,365 preservation audit, changed-file formatting, and the whole-PR spec-first/release-intent gates.
  • Passed 20 release/manifest/CI-image tests before the cache follow-up. Generated-consumer regressions failed twice before the fix and all four passed afterward.
  • Passed three real local-cache/routing tests, four focused CI/argument checks, and two package-boundary tests. The actual spec suite's unchanged second run reused its successful result in 44ms of Turbo task time after a 3.183s first run (37 tests at that checkpoint). Source/argument changes, forced runs, repeated failures, and live bypass are covered with small real pnpm/Turbo fixtures.
  • Passed the missing-sibling startup regression and the source-only-audit cache regression, each from one failure to passing.
  • Passed pnpm release:verify --manifest tmp/published-acceptance-38375257253/release-manifest.json against the actual release-run artifact and npm-published File Explorer 0.1.2 and Workspace 0.2.0, including installation, Vite build, and public-export checks. No publication occurred.

Final full package/check/build and Storybook interaction/accessibility verification is delegated to the updated PR CI run. Cold development navigation and static deployment-subpath navigation are wired into CI. The earlier local cold development run had five failures and three passes, including timeouts while Storybook's reverse-dependency index was CPU-bound; that browser acceptance still needs the updated CI result. No browser assertions or timeouts were loosened, and visual baselines were not updated.

Evidence records:

  • spec/records/2026-10-13-specification-navigation.md
  • spec/records/2026-10-13-registry-consumer-toolchain.md
  • spec/records/2026-10-13-local-test-caching.md
  • spec/records/2026-10-13-portable-specification-startup.md

Archive all 1,365 requirement statements, acceptance sections, verification rows, and original chapter sources before reorganizing the documentation. Preserve source pages in bounded fragments so historical contracts and evidence remain recoverable.

Validation: the migration audit confirms all original IDs, constraints, acceptance details, statuses, and evidence rows remain represented; intentional documentation format changes are reported separately.
Replace dense requirement tables with titled ID sections and divide the book
into 172 bounded topic and verification pages. Preserve all 1,365 original
contracts, acceptance details, statuses, and evidence against the committed
baseline; identify two authoring-format changes and six documentation rules.

Derive metadata-only mirrors, topic links, sidebar order, breadcrumbs, and
previous/next navigation from SUMMARY. Route canonical Markdown links through
the Lapis Docs container with stable anchors, relocation redirects, history,
and static deployment subpaths. Reject stale mirrors/order, duplicate routes,
and incomplete built-index coverage. Exclude generated output from watching.

Validation: migration preservation audit; spec:check (37 local tests), Docs
types and mirror checks; root check/test/build (18/18/10 successful tasks,
1,250 package tests passed and one skipped); all 243 Storybook interactions;
seven cold development navigation tests and six static-subpath tests with the
watcher-only test skipped; static Storybook build and 172-entry index audit.

Record the pre-existing tarball preflight and QMD native-module limitations,
and the recovered concurrent packaging failure, in the acceptance record.
No product APIs, visual baselines, publication, or local loader changes.
…ance

Complete or shorten 269 requirement titles so the page outline reads as topic
labels rather than truncated statements. Preserve every requirement statement,
acceptance section, verification status, evidence entry, and stable ID anchor.
Record the migration in the living checklist and correct verification guidance.
Use source references for non-catalog evidence records rather than dead routes.

Strengthen browser acceptance for the canonical nested Panels route, keyboard
Previous and Next navigation, and both legacy Panels and Problems redirects.

Validation: full preservation audit, formatting, spec:check (37 tests), rebuilt
172-chapter Storybook index, and final static deployment navigation (six passed,
watcher-only test skipped). The final cold development recheck stalled in the
Storybook reverse-dependency index (three failed, one interrupted, three not
run); preserve that evidence and fetch latest main before resolving the stall.
The prior cold development suite passed seven tests. No assertions were loosened.
…ation

Generate the published-package consumer with the root exact pnpm pin and only
its approved dependency-build list, preserving registry isolation and script
policy. Add generated-consumer regressions and evidence from the release run
artifact against published File Explorer 0.1.2 and Workspace 0.2.0.

Carry main CI-image snapshots into bounded owning topics and update pin
automation. Run development and static Docs navigation in PR CI, preserve
strict CI command contracts, and record the remaining local cold-navigation
timeouts without weakening browser assertions.

Validation: 20 release/manifest/image tests, two focused CI wiring tests,
spec:check with 37 specification tests, original-1365 preservation audit,
authored-file formatting, and actual npm consumer installation/Vite/export
verification pass. Final full lanes are delegated to PR CI by user request.
Register repository-level Storybook, specification, release-tooling, and browser
test tasks behind the existing bounded runner. Preserve raw suite commands for
CI without recursive orchestration, and keep tests of external state and
baseline mutation uncached. Include workspace, configuration, local-install,
and runtime inputs; forward and hash test arguments; support forced fresh runs
and disable cache reads/writes for live Storybook acceptance.

Suppress replayed logs on cache hits and clarify that local disk caching works
without remote credentials. Update the governing specification and document
root commands for cached package selection.

Validation: the routing regression moves from one failure to passing. Three
focused tests prove real pnpm/Turbo cache reuse, source/argument invalidation,
repeated failures, forced runs, and live bypass. Four command/CI checks, two
package-boundary tests, spec:check with 37 specification tests, formatting,
and original-1365 preservation pass. The unchanged spec suite hits cache in
44ms of Turbo task time after a 3.183s first run. Full suites remain in PR CI.
Fix PR CI after all 243 Storybook interaction/axe tests passed: the development
Docs web-server command incorrectly required a sibling plugin release manifest
and failed before running its eight browser tests. Add an installed-graph
Storybook startup entry and select it in the Playwright configuration, retaining
explicit local tarball preparation and the existing owned supervisor.

Add a focused regression that imports the actual Playwright configuration and
executes its startup recipe without sibling artifacts. Restrict live-cache
classification to browser tasks so pure Storybook source audits retain caching.
Update mapped guidance, the portable-startup contract, and evidence.

Validation: missing-manifest startup regression and pure-audit cache regression
each move from one failure to passing. Four focused CI/routing checks,
spec:check with 38 specification tests, formatting, release-intent, and the
original-1365 preservation audit pass. Full browser acceptance is delegated to
the updated PR CI run under the user requested local-check limit.
@stevejuma stevejuma changed the title Improve specification navigation and pin release-consumer pnpm policy Improve spec navigation, local test caching, and release verification Oct 13, 2026
@stevejuma
stevejuma merged commit 3a732d4 into main Oct 13, 2026
8 checks passed
@stevejuma
stevejuma deleted the improve-specification-docs-and-release-verification branch October 13, 2026 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant