Skip to content

docs(storefront): conform tutorial + fresh-ui/web-layer to alpha.18 feature sweep#233

Merged
rickylabs merged 1 commit into
mainfrom
docs/storefront-and-feature-conformance
Jul 2, 2026
Merged

docs(storefront): conform tutorial + fresh-ui/web-layer to alpha.18 feature sweep#233
rickylabs merged 1 commit into
mainfrom
docs/storefront-and-feature-conformance

Conversation

@rickylabs

Copy link
Copy Markdown
Owner

What

Storefront tutorial D-01…D-05 conformance to the shipped alpha.18 feature sweep (#206#231), plus accuracy reconciliation on the fresh-ui / web-layer pages that sweep touched. First slice of the docs march to 0.0.1-stable.

Docs-only. Authored via a Claude documentation workflow, applied + validated + committed on the Windows/Claude side (no framework source touched).

Storefront conformance

# File Change
D-01 01-scaffold.md Aspire dashboard URL is https (×3); fileTree includes database/ + tests/.
D-02 02-catalog-service.md Real #208 CRUD surface — createCrudContract + @database/zod + context.db; errors thrown via the contract's typed errors.NOT_FOUND (removed hand-rolled notFound import); router nests health under products (removed invented health-router import).
D-03 03-cart-contracts.md Register in mod.ts, PascalCase CartContractV1, import from @my-shop/contracts + the ./versions/v1 subpath. Also realigned ch2's products.contract.ts exports to PascalCase (ProductsContract/ProductsContractV1) so the ch2↔ch3 imports agree.
D-04 04-checkout-saga.md, 05-shipping-webhook.md Public netscript plugin install saga|trigger --name … --samples.

Feature-sweep reconciliation (fresh-ui / web-layer)

Validation

  • deno task build ✓ (308 files)
  • deno task check:links ✓ (18,722 internal links across 131 pages resolve)
  • deno task check:caveats ✓ (30 caveat markers resolve)
  • No deno fmt run on docs/site (per docs build policy).

Scope

Refs #153 — does not close it; the full manual Run-2 walk stays for after the release cut. Remaining docs-march work is tracked in the umbrella #232 and lands as focused PRs after the next release cut.

Refs #153
Refs #232

🤖 Generated with Claude Code

…eature sweep

Storefront tutorial D-01…D-05 conformance to the shipped #206#231 surface,
plus accuracy reconciliation on the fresh-ui/web-layer pages the sweep touched.

D-01 (01-scaffold): Aspire dashboard URL is https; fileTree includes
  database/ and tests/.
D-02 (02-catalog-service): real #208 CRUD surface — createCrudContract +
  @database/zod + context.db; errors thrown via the contract's typed
  errors.NOT_FOUND (no hand-rolled notFound import); router nests health
  under products (no invented health-router import).
D-03 (03-cart-contracts): register in mod.ts, PascalCase CartContractV1,
  import from @my-shop/contracts and the ./versions/v1 subpath. Reconciled
  02's products.contract.ts exports to the same PascalCase convention
  (ProductsContract/ProductsContractV1) so ch2↔ch3 imports agree.
D-04 (04/05): public `netscript plugin install saga|trigger --name … --samples`.

Feature recon to the sweep: DataTable→DataGrid (#209/#225), Icon primitive
(#211/#224) and DataGrid in fresh-ui root exports, Dropzone/prompt-input
mentions (#214/#229, #212/#226), managed <Form> class + <form> attrs
(#213/#228), useIslandMutation onMutate/onSettled (#210/#227).

Docs-only. build + check:links + check:caveats green. Refs #153.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012wKHquACkXnWPDgJYhhFjN
@augmentcode

augmentcode Bot commented Jul 2, 2026

Copy link
Copy Markdown
🤖 Augment PR Summary

Summary: This PR updates NetScript documentation to match the shipped 0.0.1-alpha.18 “feature sweep” behavior, with a focus on the Storefront tutorial (chapters D-01…D-05) and Fresh UI / web-layer reference pages.

Changes:

  • Storefront tutorial: switches Aspire dashboard links to https://localhost:18888 and refreshes the scaffold tree/checklist (adds database/ and tests/).
  • Catalog service tutorial: aligns contract/handler examples with the real CRUD surface (createCrudContract, @database/zod inputs, context.db) and typed contract errors.
  • Cart contracts tutorial: moves registration guidance to contracts/versions/v1/mod.ts, updates export/import casing, and adjusts the typed client example.
  • Saga + trigger chapters: replaces contributor-only netscript-dev invocations with the public netscript plugin install commands.
  • Fresh UI docs: reconciles terminology/exports (Icon primitive, DataGrid) and updates related capability/reference copy.
  • Web-layer docs: clarifies managed <Form> attribute forwarding and expands useIslandMutation lifecycle callback documentation.

Technical Notes: Docs-only change set; includes consistency updates to match current public package exports and scaffolded code patterns.

🤖 Was this summary useful? React with 👍 or 👎

@augmentcode augmentcode Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. 2 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

rows: [
{ name: "netscript ui:init", type: "install foundation", desc: "Installs the Fresh UI foundation set into an app workspace. The scaffold runs the equivalent for you; run it once when adding UI to an app that lacks it." },
{ name: "netscript ui:add <name>", type: "add an item", desc: "Copies one registry item or a named collection into components/ui/, wires its CSS, and merges any required deno.json imports. Example: netscript ui:add data-table." }
{ name: "netscript ui:add <name>", type: "add an item", desc: "Copies one registry item or a named collection into components/ui/, wires its CSS, and merges any required deno.json imports. Example: netscript ui:add data-grid." }

@augmentcode augmentcode Bot Jul 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

netscript ui:add data-grid looks like it would fail today because the Fresh UI registry manifest still defines data-table (and the CLI errors on unknown registry item names). This also conflicts with the existing netscript ui:add data-table examples elsewhere in the docs.

Severity: medium

Other Locations
  • docs/site/capabilities/fresh-ui.md:101

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

export const v1 = {
products: productsContractV1,
cart: cartContractV1,
products: ProductsContractV1,

@augmentcode augmentcode Bot Jul 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This uses ProductsContractV1/CartContractV1 as the values in v1, but the scaffolded contract templates distinguish *ContractV1 (raw contract) vs *V1 (implemented contract with .handler() / $context). If a reader copy/pastes this into a default scaffold without also renaming the exports, it’s very likely to break type-checking or lead to wiring the non-implemented contract into v1 by mistake.

Severity: low

Other Locations
  • docs/site/tutorials/storefront/02-catalog-service.md:114
  • docs/site/tutorials/storefront/02-catalog-service.md:129

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@rickylabs
rickylabs merged commit 943f0f0 into main Jul 2, 2026
6 checks passed
@rickylabs
rickylabs deleted the docs/storefront-and-feature-conformance branch July 2, 2026 08:04
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