0xMiden / 0xMiden/docs

Explain Transaction crates API + improve TypeScript SDK docs

Ouverte
#362 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation
Langage dominant
TypeScript
Étoiles
10
Forks
50
Merge moyen
22 j 23 h
PR mergées (30 j)
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.**

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Le problème concerne l'amélioration de la documentation pour l'API Transaction crates et le SDK TypeScript. Tout d'abord, localisez la documentation existante dans le dépôt, probablement dans un répertoire `docs/` ou dans les commentaires du code source. Examinez les signatures actuelles de l'API Transaction et les exemples du SDK TypeScript. L'objectif est d'ajouter des explications de haut niveau et des exemples plus approfondis. Vérifiez si d'autres dépôts sont mentionnés pour consolidation, et comprenez la structure afin de proposer un emplacement de documentation unifié.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
40/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.