0xMiden / 0xMiden/web-sdk

Improve Structure + Fix Broken Links in TypeScript WebClient Docs

未关闭 适合新手
#120 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
TypeScript
星标
1
派生
21
平均合并
12 小时 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

贡献指南

打开贡献指南

调研方向

Start by locating the TypeScript WebClient documentation files in the repository, likely in a docs/ or similar directory. Audit the internal links mentioned (Accounts, Webclient, Account, AccountID, import, export, sync, transactions) to identify broken references. Then, restructure the documentation to mirror the Rust section's hierarchy (Installation, Getting Started, Features, Examples). Verify fixes by building or previewing the docs locally.

由索引模型根据 Issue 内容生成。

评估

技术栈
typescript
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
描述清楚
新手友好度
65/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。