Skip to content

chore: overhaul docs and fix associated_token_address typo#517

Open
madninja wants to merge 2 commits intomasterfrom
chore/docs-and-api-cleanup
Open

chore: overhaul docs and fix associated_token_address typo#517
madninja wants to merge 2 commits intomasterfrom
chore/docs-and-api-cleanup

Conversation

@madninja
Copy link
Copy Markdown
Member

Summary

  • Rewrite root README with complete CLI command reference (all 15 commands), workspace overview, swap docs, and full environment variable tables
  • Add helium-lib crate README with module overview, feature flags, re-exports, and usage example
  • Add rustdoc comments across all public items in helium-lib (~270 items were undocumented)
  • Fix associated_token_adress typo -> associated_token_address across 7 files (16 call sites) — breaking API change

madninja and others added 2 commits April 12, 2026 21:19
Rewrite root README with complete CLI command reference including the
new swap command, all environment variables, and workspace overview.
Add helium-lib crate README with module table, feature flags, and
usage example. Add rustdoc comments across all public items in
helium-lib. Rename associated_token_adress -> associated_token_address
throughout the codebase.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Remove nonexistent --format global option from README
- Fix verify -> info for sharded wallet example
- Remove false transfer/pay alias claim
- Remove dc from transferable token list
- Fix Jupiter V6 -> V2 in helium-lib README
- Fix inaccurate module docs (queue, schedule, boosting, dc)
- Standardize all doc comments to third-person voice (RFC 505)
- Add missing blank lines before doc comments

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant