Background
The @veil/sdk package exposes 11 methods (register, deploy, login, signAuthEntry, getNonce, addSigner, removeSigner, getSigners, setGuardian, initiateRecovery, completeRecovery). The docs site has a manually-written reference page but lacks parameter types, return types, and usage examples for several methods.
What to build
Improve the SDK reference page in the Nextra docs site to include full TypeScript signatures, parameter descriptions, and a short usage example for every method.
Key files
frontend/docs/pages/sdk-reference.mdx — page to improvesdk/src/useInvisibleWallet.ts — source of truth for types/signatures
Suggested execution
git checkout -b docs/sdk-api-reference-improvements
- For each of the 11 methods, add: TypeScript function signature, parameter table (name, type, description), return type, and a 3-5 line usage example
- Consider using TypeDoc to auto-generate and then copy the output into MDX
- Verify all code examples are syntactically correct
Example commit message:
docs: add full parameter and return type reference for all 11 SDK methods
Acceptance criteria
Drips Wave · Complexity: Trivial · 100 points
Comment below to request assignment. PR must include Closes #[this issue].
Background
The
@veil/sdkpackage exposes 11 methods (register, deploy, login, signAuthEntry, getNonce, addSigner, removeSigner, getSigners, setGuardian, initiateRecovery, completeRecovery). The docs site has a manually-written reference page but lacks parameter types, return types, and usage examples for several methods.What to build
Improve the SDK reference page in the Nextra docs site to include full TypeScript signatures, parameter descriptions, and a short usage example for every method.
Key files
frontend/docs/pages/sdk-reference.mdx— page to improvesdk/src/useInvisibleWallet.ts— source of truth for types/signaturesSuggested execution
Example commit message:
docs: add full parameter and return type reference for all 11 SDK methodsAcceptance criteria