Review documentation examples and content
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- documentation, testing
Research direction
Review the .mdx files under the listed docs/content/docs/ sections, skipping entries marked Coming soon, WIP, or incomplete. Run locally runnable examples with npx tsx test.ts and mark network- or wallet-dependent examples as Skip. Report each example's result and provide clarity, issues, and suggestions using the specified format.
Written by the indexing model from the issue text.
Description
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
```
- Dominant language
- TypeScript
- Stars
- 22
- Forks
- 31
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 27
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from IntersectMBO/evolution-sdk
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
IntersectMBO/evolution-sdk#579 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
IntersectMBO/evolution-sdk#559 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
IntersectMBO/evolution-sdk#557 ·
Maintainers usually reply within 1 day
-
dependencies good first issue
Difficulty 1/5 Under an hour Newbie friendliness 93/100
IntersectMBO/evolution-sdk#541 ·
Maintainers usually reply within 1 day
-
bug external-review
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
IntersectMBO/evolution-sdk#530 ·
Maintainers usually reply within 1 day
All issues in IntersectMBO/evolution-sdk
Similar issues
-
enhancement providers-api ui-dashboard
Difficulty 2/5 1-3 hours Newbie friendliness 61/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
external-issue to-triage
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
needs triage
Difficulty 1/5 Under an hour Newbie friendliness 88/100
homarr-labs/homarr#6976 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day