Skip to content

epic: docs — march to 0.0.1-stable (coverage & accuracy) #232

Description

@rickylabs

Docs march to 0.0.1-stable — coverage & accuracy umbrella

Tracking issue for the remaining documentation work to reach a stable-quality docs set for 0.0.1. The first slice — storefront tutorial D-01…D-05 conformance plus fresh-ui/web-layer accuracy reconciliation to the alpha.18 feature sweep (#206#231) — ships in the linked PR. This issue enumerates everything that pass deliberately deferred, so the rest can land as focused PRs after the next release cut.

Every item below is grounded in the deep-dive audit run for the first PR. Items are grouped by the follow-up PR that should own them.

✅ Resolved in the first PR (for reference)

  • Storefront D-01 Aspire dashboard httphttps; fileTree adds database/+tests/.
  • Storefront D-02 real feat(cli): scaffold CRUD surface DX upgrade (C1–C10) [#153 CODE] #208 CRUD surface (createCrudContract + @database/zod + context.db), typed errors.NOT_FOUND, router health-nesting.
  • Storefront D-03 mod.ts registration + CartContractV1 casing + @my-shop/contracts/versions/v1 subpath — and ch2 products.contract.ts exports realigned to PascalCase (ProductsContract/ProductsContractV1) so ch2↔ch3 imports agree.
  • Storefront D-04 public netscript plugin install saga|trigger --name … --samples.
  • fresh-ui/web-layer recon: DataTable→DataGrid, Icon+DataGrid root exports, Dropzone/prompt-input mentions, managed <Form> class/attrs, useIslandMutation onMutate/onSettled.

A. Storefront tutorial — Run-2 grounding (after release cut, Refs #153)

  • Full manual Run-2 walk against the published scaffold (the 🔬 Tutorial DX Eval (alpha.17, ARMED): lock criteria + track 4 tutorial runs + derived backlog #153 second run).
  • Verify 01-scaffold.md dry-run block (netscript init my-shop --dry-run) + apiTable options against real netscript init --help — the CLI init/scaffold command source was not in the audit's ground-truth set, so flags were left unchanged (nothing contradicted them).
  • Verify the @my-shop/contracts/versions/v1 mod.ts re-export barrel pattern (and the ch2-registers-products-before-ch3-adds-cart flow) against a real scaffolded contracts workspace — currently best-grounded inference, no generated mod.ts was available to diff.
  • Verify literal port numbers (18888, 4318, 3001, 8091–8093) against live scaffold.runtime e2e output.
  • Consider adding a feat(aspire): enable browser-logs devtools integration by default + streams HTTP/2 caveat (#218) #231 browser-logs row to 06-deploy.md's dashboard-surfaces table (if it belongs in the tutorial vs. only the how-to guides).

B. Sibling tutorial + how-to sweep (same defect classes, other files)

  • workspace/01-scaffold.md: Aspire dashboard http://localhost:18888https in the "bring up orchestration" step + checklist (same defect class as storefront D-01).
  • how-to/customize-fresh-ui.md: netscript ui:add data-table→data-grid, and refresh prompt-input/dropzone copy with the new drag+paste+multi-file / auto-grow behavior.

C. fresh-ui / web-layer reference depth (feature-sweep coverage)

D. Aspire / telemetry docs (coverage gaps, not contradictions)

E. Streams docs (scoping decision needed)

F. Workers docs verification


Generated from the first-slice deep-dive audit. First PR is docs-only and Refs #153 (does not close it — Run-2 remains).

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions