Review documentation examples and content
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- typescript
- Área
- documentation, testing
Línea de trabajo
Revisa los archivos .mdx de las secciones indicadas de docs/content/docs/ y omite las entradas marcadas como Coming soon, WIP o incomplete. Ejecuta los ejemplos que puedan ejecutarse localmente con npx tsx test.ts y marca como Skip los ejemplos que dependan de la red o de una wallet. Informa del resultado de cada ejemplo y proporciona claridad, problemas y sugerencias usando el formato especificado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Task: Review Documentation Examples and Content
Goal: Test all code examples and provide feedback on documentation clarity and completeness.
Files to Review
| Section | Path |
|---|---|
| Getting Started | docs/content/docs/introduction/ |
| Clients | docs/content/docs/clients/ |
| Wallets | docs/content/docs/wallets/ |
| Transactions | docs/content/docs/transactions/ |
| Smart Contracts | docs/content/docs/smart-contracts/ |
| Addresses | docs/content/docs/addresses/ |
| Assets | docs/content/docs/assets/ |
| Staking | docs/content/docs/staking/ |
| Governance | docs/content/docs/governance/ |
| Querying | docs/content/docs/querying/ |
| Encoding | docs/content/docs/encoding/ |
| Time | docs/content/docs/time/ |
| Devnet | docs/content/docs/devnet/ |
Instructions
- Open each `.mdx` file in the section
- Skip any that say "Coming soon", "WIP", or are clearly incomplete
- For each code example:
- If it can run locally: run it with `npx tsx test.ts` and report pass or fail
- If it needs network/wallet: mark as Skip
- For the text content, provide feedback on:
- Is the description clear and accurate?
- Would a beginner understand it?
- Are there confusing parts or missing context?
- Any suggestions for improvement?
Report Format
```
docs/content/docs/wallets/index.mdx
Examples
- Example 1 (line 23): Pass
- Example 2 (line 45): Fail - "Property 'x' does not exist"
- Example 3 (line 67): Skip - needs funded wallet
Content Feedback
- Clear: Yes / Mostly / No
- Issues: List any problems found
- Suggestions: List any improvements
```
- Lenguaje dominante
- TypeScript
- Estrellas
- 22
- Forks
- 33
- Merge medio
- 2 d 1 h
- PR fusionados (30 d)
- 44
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de IntersectMBO/evolution-sdk
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
IntersectMBO/evolution-sdk#559 ·
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
IntersectMBO/evolution-sdk#557 ·
Los mantenedores suelen responder en 1 día
-
dependencies good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 93/100
IntersectMBO/evolution-sdk#541 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
IntersectMBO/evolution-sdk#518 ·
Los mantenedores suelen responder en 1 día
-
enhancement external-review
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
IntersectMBO/evolution-sdk#456 · 1 comentario ·
Los mantenedores suelen responder en 1 día
Todos los issues de IntersectMBO/evolution-sdk
Issues similares
-
priority:high
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
immich-app/immich#32426 ·
Los mantenedores suelen responder en 1 día
-
documentation good first issue hacktoberfest help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
libredb/libredb-studio#1756 ·
Los mantenedores suelen responder en 1 día
-
state:triage-needed
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día