0xMiden / 0xMiden/docs

Clarify TypeScript Client and React SDK tutorial IA

Offen Anfängerfreundlich
#292 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TypeScript
Sterne
10
Forks
50
Ø Merge
22 T. 23 Std.
Gemergte PRs (30 T.)
1

Beschreibung

## 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

- 0xMiden/docs#275 tracks the original request for practical React SDK account-state and balance examples.
- The runnable tutorial implementation should live in `0xMiden/tutorials`.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Untersuchen Sie die Navigationsstruktur der Dokumentationsseite, um herauszufinden, wo 'Web Client' als Label verwendet wird. Aktualisieren Sie diese Labels in den entsprechenden Konfigurations- oder Markdown-Dateien auf 'TypeScript Client'. Stellen Sie sicher, dass die React SDK-Referenzseiten auf den Tutorial-Quellcode im Repository 0xMiden/tutorials verlinken. Überprüfen Sie, ob der Dokumentations-Build nach den Änderungen erfolgreich durchläuft.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
react, typescript
Bereich
developer-experience, documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Ruhig
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
75/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.