Skip to content

Improve sidebar labels in Embedded Wallets SDK usage sections #2862

@bgravenorst

Description

@bgravenorst

Problem

Sidebar labels in the usage/ sections across Embedded Wallets SDK platforms use raw method
names (camelCase API identifiers) as navigation labels. These are ambiguous and not
self-explanatory for readers scanning the sidebar.

Example: iOS SDK usage/ section

Current sidebar label Issue
connectTo Doesn't describe what the user achieves
request Ambiguous — request what?
enableMFA Code identifier, not a human-readable label
manageMFA Same
getUserInfo Same
getPrivateKey Same
getEd25519PrivateKey Same
showWalletUI Same
logout Same

Suggested approach

Replace code-style sidebar labels with descriptive, human-readable labels that describe the
action or outcome. For example:

Current Suggested
connectTo Sign in a user
request Send requests
enableMFA Enable MFA
manageMFA Manage MFA
getUserInfo Get user info
getPrivateKey Get private key
getEd25519PrivateKey Get Ed25519 private key
showWalletUI Show wallet UI
logout Sign out

Scope

This affects usage/ sections across all SDK platforms:
iOS, Android, React Native, Flutter, Unity, Unreal, JS, Vue, React.

Metadata

Metadata

Assignees

No one assigned

    Labels

    embedded walletsContent related to the embedded wallet content

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions