0xMiden / 0xMiden/docs

Restructure client docs into Rust / Web / React three-tier hierarchy

オープン
#268 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る
documentation
主要言語
TypeScript
スター
10
フォーク
50
平均マージ
22日 23時間
マージ済み PR(30日)
1

説明

Source: DevEx Sync (Notion).

Wiktor is splitting the client docs into three hierarchies — Rust client, Web client, React client — matching the Rust documentation approach (initialization, account APIs, transactions, notes per surface).

Currently:

- Rust client is ingested from `miden-client/` and follows the canonical hierarchy.
- Web client and React SDK pages are authored locally in this repo and have a less consistent shape.

Scope:

- Define and document the canonical three-tier IA (Rust / Web / React) with parallel sub-page structure.
- Reorganise existing Web client + React SDK pages into that structure.
- Ensure `deploy-docs.yml` ingestion paths still preserve the locally-authored Web/React siblings.

Upstream dependency: coordinated with Wiktor's `miden-client` repo split. Ship the docs IA in lockstep with the SDK split.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

リポジトリ内の現在のドキュメント構造を調査し、ローカルで作成された Web クライアントと React SDK のページに焦点を当てます。`deploy-docs.yml` ファイルを確認して、取り込みパスを理解します。目標は、既存のコンテンツを新しい 3 層階層(Rust/Web/React)に並列サブ構造で再編成し、デプロイ構成が引き続き機能することを確認することです。まず、現在のページの場所と提案された新しい構造をマッピングすることから始めてください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
55/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。