Skip to content

docs: add Stellar React hooks reference page (#44)#68

Merged
truthixify merged 1 commit into
wraith-protocol:developfrom
boalambo:docs/stellar-react-hooks-reference
Jun 29, 2026
Merged

docs: add Stellar React hooks reference page (#44)#68
truthixify merged 1 commit into
wraith-protocol:developfrom
boalambo:docs/stellar-react-hooks-reference

Conversation

@boalambo

Copy link
Copy Markdown
Contributor

Summary

Adds the full reference page for @wraith-protocol/sdk-react hooks as specified in #44.

Changes

  • reference/stellar-react-hooks.mdx — new reference page covering all 5 hooks
  • sdk/chains/stellar.mdx — added link to hooks reference
  • getting-started.mdx — added link to hooks reference
  • .gitignore — removed reference/ exclusion so the directory is tracked

Hooks documented

  • useStellarStealthKeys
  • useStellarAnnouncementScan
  • useStellarSendStealthPayment
  • useStellarName
  • useStellarBalance

Each hook includes: signature, parameters, return type, side effects, JSX example, and common pitfalls.

Additional coverage

  • React Strict Mode behavior notes per hook
  • React Native / mobile caveats section
  • Full app example using all five hooks together

Notes

  • Page is gated on @wraith-protocol/sdk-react shipping
  • .gitignore change is intentional — reference/ was previously excluded, blocking the spec'd file path

Acceptance criteria

  • reference/stellar-react-hooks.mdx committed
  • Full app example using all hooks
  • Strict Mode notes accurate
  • Linked from SDK Stellar page and getting-started

Closes #44

- Add reference/stellar-react-hooks.mdx with full hook reference
- Cover useStellarStealthKeys, useStellarAnnouncementScan,
  useStellarSendStealthPayment, useStellarName, useStellarBalance
- Include signatures, params, return types, JSX examples, pitfalls
- Add React Strict Mode and React Native caveat sections
- Add full app example using all five hooks
- Link from SDK Stellar page and getting-started

Gated on @wraith-protocol/sdk-react shipping.
@drips-wave

drips-wave Bot commented Jun 29, 2026

Copy link
Copy Markdown

@boalambo Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@truthixify

Copy link
Copy Markdown
Contributor

Clean merge. 717-line Stellar React hooks reference page. Solid coverage of the sdk-react hooks. Thanks @boalambo.

@truthixify
truthixify merged commit 6db75d5 into wraith-protocol:develop Jun 29, 2026
@boalambo
boalambo deleted the docs/stellar-react-hooks-reference branch July 6, 2026 08:46
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.

Stellar React hooks reference (when sdk-react ships)

2 participants