docs: add detailed parameter documentation for SIWX custom interface #588
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR addresses a documentation consistency issue by adding detailed parameter documentation for the SIWX custom interface. Previously, the SIWX documentation only showed the interface definition and had inline comments, but lacked the comprehensive parameter documentation section that exists for SIWE.
Key Changes:
/snippets/appkit/shared/siwx/siwx-custom.mdx
signOutOnDisconnect
with proper type annotations, default values, and descriptionsContext:
This addresses a GitHub comment noting that
signOutOnDisconnect
documentation was missing from the SIWX custom interface docs. While the parameter was present in the TypeScript interface, it lacked the user-friendly parameter documentation that developers expect.Tests
pnpm run spell
- 0 issues found)Direct link to the deployed preview files
Review Checklist
High Priority:
signOutOnDisconnect
documentation is technically accurate (defaults totrue
, clears sessions on disconnect)Medium Priority:
Notes
Requested by: TomTom (tomas.rawski@reown.com)
Link to Devin run: https://app.devin.ai/sessions/eaf94744cb6b4084a5e011c6c19ac6ae