-
Notifications
You must be signed in to change notification settings - Fork 7
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
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
```
danbarukadanbaruka
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation