0xMiden / 0xMiden/docs

Explain Transaction crates API + improve TypeScript SDK docs

Abierto
#362 2 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation
Lenguaje dominante
TypeScript
Estrellas
10
Forks
50
Merge medio
22 d 23 h
PR fusionados (30 d)
1

Descripción

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.**

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

The issue is about improving documentation for the Transaction crates API and TypeScript SDK. First, locate the existing docs in the repository, likely in a `docs/` directory or within source code comments. Review the current Transaction API signatures and TypeScript SDK examples. The goal is to add higher-level explanations and more in-depth examples. Check if there are other repos mentioned for consolidation, and understand the structure to propose a unified doc location.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
40/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.