0xMiden / 0xMiden/docs

Explain Transaction crates API + improve TypeScript SDK docs

Open
#362 2 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
10
Forks
50
Avg merge
22d 23h
Merged PRs (30d)
1

Description

Feedback:

- Suggested adding more natural language explanations for the Transaction crates API (e.g. what the transaction APIs actually do, not just the signatures).
- Documentation is still in progress, but more in-depth examples for the TypeScript SDK would help a lot.
- Suggested having all docs in one place (currently hopping repo to repo feels messy).

Ask:

- Add clearer, higher-level explanations + examples for the Transaction crates API.
- Expand TypeScript SDK docs with deeper examples.
- Consolidate docs into one central place for easier navigation.

Why:
Makes the dev experience smoother and reduces friction when learning the stack.

**This feedback came through DevRel applications.**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.