0xMiden / 0xMiden/web-sdk

Improve Structure + Fix Broken Links in TypeScript WebClient Docs

未關閉 適合新手
#120 1 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
TypeScript
星號
1
分支
21
平均合併
13 小時 14 分鐘
30 天內合併 PR
41

描述

While reviewing the Miden client documentation, I noticed that the TypeScript WebClient section needs improvement in two key areas:

1. Structural Consistency with Rust Docs
The Rust section has a well-organized hierarchy:

- Installation

- Getting Started

- Features

- Examples

- CLI, etc.

In contrast, the TypeScript docs are flat and lack clear onboarding sections like:

- Setup / Installation

- Getting Started

- Usage Examples

Suggestion:
Adopt a similar structure as Rust for TypeScript WebClient to improve navigation and developer onboarding.

2. Broken Links in TypeScript (WebClient) Documentation
Several internal links are currently broken in the TypeScript WebClient documentation, making it difficult to navigate or reference key types and modules

Examples:

In the Accounts section
- Broken internal links to:
- Webclient
- Account
- AccountID

Other sections like import, export, sync, transactions, etc. also have broken internal references.

Would be good to audit and fix these across the WebClient docs

貢獻指南

開啟貢獻指南

研究方向

首先在程式碼倉庫中找到 TypeScript WebClient 的文件檔案,很可能在 docs/ 或類似目錄中。稽核提到的內部連結(Accounts、Webclient、Account、AccountID、import、export、sync、transactions)以識別損壞的參照。然後,重構文件以反映 Rust 部分(Installation、Getting Started、Features、Examples)的層級結構。透過本地建置或預覽文件來驗證修復。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
typescript
領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
描述清楚
新手友好度
65/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。