Skip to content

docs(xchat): add Security practices section for WASM UI apps and private keys - #305

Open
santiagomed wants to merge 1 commit into
mainfrom
docs/xchat-security-practices
Open

docs(xchat): add Security practices section for WASM UI apps and private keys#305
santiagomed wants to merge 1 commit into
mainfrom
docs/xchat-security-practices

Conversation

@santiagomed

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a Security practices group to the Chat API sidebar with two guides:
    1. Building UI apps with WASM — run Chat XDK in the browser so private keys never hit the app server; unlock once per session (not per message).
    2. Handling private keys — treat PIN/private keys as root credentials; OAuth revoke does not revoke keys; storage and operational checklist.
  • Links both pages from the Chat API introduction next steps.
  • Avoids internal jargon (e.g. "soft users").

Why

Third-party chat UIs that collect a user's encryption PIN on a server (or store root keys poorly) create irreversible risk: disconnecting OAuth does not take those keys back. Document the WASM client path and key-handling best practices for external developers.

Test plan

  • Preview in Mintlify: Chat API → Security practices in the sidebar
  • Open /xchat/building-ui-apps-with-wasm and /xchat/handling-private-keys
  • Confirm introduction "Next steps" links resolve
  • Spot-check no "soft user" / internal-only terminology

…ate keys

Add sidebar guides for browser WASM crypto and private key / PIN handling so
client apps keep root keys on-device and do not confuse OAuth revoke with key
access.
@mintlify

mintlify Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
x-corp 🟢 Ready View Preview Jul 30, 2026, 8:17 PM

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