IntersectMBO / IntersectMBO/evolution-sdk

Review documentation examples and content

Offen
#144 17 Kommentare 4 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation
Vorherrschende Sprache
TypeScript
Sterne
22
Forks
30
Ø Merge
5 Std. 29 Min.
Gemergte PRs (30 T.)
12

Beschreibung

## 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

1. Open each \`.mdx\` file in the section
2. Skip any that say "Coming soon", "WIP", or are clearly incomplete
3. 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
4. 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
\`\`\`

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
documentation, testing
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.