Skip to content

Clarify TypeScript Client and React SDK tutorial IA #292

@BrianSeong99

Description

@BrianSeong99

Problem

React SDK examples should be easy to find from the docs, but the long runnable walkthroughs should be source-owned in 0xMiden/tutorials and ingested into the docs site rather than duplicated directly in 0xMiden/docs.

The current tutorial IA also uses the label "Web Client". That is accurate at the runtime level, but it is less clear beside "Rust Client". "TypeScript Client" is a better top-level label, with page copy explaining that these examples run in browser/WASM environments.

Proposed scope

  • Rename the docs tutorial/recipe navigation label from "Web Client" to "TypeScript Client" where appropriate.
  • Keep browser-specific caveats in the page copy: WASM init, bundler config, IndexedDB/local client store, and browser-only APIs.
  • Keep React SDK reference material under Build > Tools > Clients > React SDK.
  • Link from React SDK reference pages to the source-owned tutorials in 0xMiden/tutorials.
  • Avoid duplicating long runnable React tutorials directly in the docs repo; ingest or link to the tutorial source instead.
  • Update current docs and versioned docs only where the affected path is already visible in the published version.

Acceptance criteria

  • The tutorial/recipe IA presents "TypeScript Client" instead of "Web Client" in the docs site navigation where appropriate.
  • React SDK reference pages point readers to the runnable tutorial examples.
  • The docs clarify the split between React SDK hooks, lower-level TypeScript/WebClient APIs, and browser runtime requirements.
  • The docs build passes.

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions