0xMiden / 0xMiden/docs

Clarify TypeScript Client and React SDK tutorial IA

Đang mở
#292 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
TypeScript
Star
10
Fork
50
Merge trung bình
22 ngày 23 giờ
Pull request đã merge (30 ngày)
1

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.