Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: xdevplatform/docs
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: main
Choose a base ref
...
head repository: xdevplatform/docs
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: xchat-docs
Choose a head ref
Checking mergeability… Don’t worry, you can still create the pull request.
  • 10 commits
  • 21 files changed
  • 1 contributor

Commits on Mar 13, 2026

  1. Add XChat API documentation

    - Add new XChat tab with introduction, cryptography primer, getting started guide, and XDK reference
    - Add cross-links from X Activity API and Direct Messages docs
    - Create docs/xchat/ directory with 4 new documentation pages
    tcaldwell-x committed Mar 13, 2026
    Configuration menu
    Copy the full SHA
    f87e26a View commit details
    Browse the repository at this point in the history
  2. Add XChat-specific real-time events page

    - Create xchat/real-time-events.mdx with chat event documentation
    - Update sidebar to use new page instead of x-api/ links
    - Users now stay in XChat API context when viewing real-time events
    - Includes CRC validation, webhook handling, and decryption examples
    tcaldwell-x committed Mar 13, 2026
    Configuration menu
    Copy the full SHA
    e0bc6fd View commit details
    Browse the repository at this point in the history
  3. Add API reference section to real-time events page

    - Activity Subscriptions: create, list, update, delete
    - Activity Stream: persistent HTTP connection
    - Webhook Management: register, list, validate, delete
    - Links to full endpoint docs for details
    tcaldwell-x committed Mar 13, 2026
    Configuration menu
    Copy the full SHA
    ac8ae46 View commit details
    Browse the repository at this point in the history
  4. Add troubleshooting guide and sample apps section

    - Create xchat/troubleshooting.mdx with common errors and solutions
      - Key management errors (unlock, missing keys)
      - Decryption errors (invalid ciphertext, signature verification)
      - Webhook errors (CRC, signature, not receiving events)
      - API errors (401, 429, 400)
      - Juicebox errors (network, token expiry)
      - Debugging tips and getting help
    
    - Add sample applications section to getting-started.mdx
      - Links to Rust decode_chat example
      - Links to TypeScript Juicebox demo
      - Links to Swift iOS demo
      - Reference to inline customer service bot example
    
    - Update docs.json sidebar to include troubleshooting page
    tcaldwell-x committed Mar 13, 2026
    Configuration menu
    Copy the full SHA
    c38735a View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    a988b46 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    c876bb5 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    8531323 View commit details
    Browse the repository at this point in the history
  8. Rename XChat to Chat throughout documentation

    - XChat API → Chat API
    - XChat XDK → Chat XDK
    - Updated tab name in docs.json
    - Updated cross-references in x-api docs
    - Updated openapi.json descriptions
    tcaldwell-x committed Mar 13, 2026
    Configuration menu
    Copy the full SHA
    1e84bd5 View commit details
    Browse the repository at this point in the history

Commits on Mar 23, 2026

  1. Fix xchat docs accuracy for OpenAPI spec 2.160

    - real-time-events.mdx: Fix wrong SDK imports (XClient -> Client), replace
      broken xchat_xdk.ChatClient/decrypt_message with correct chat_xdk.Chat/
      decrypt_event(), correct event payload structure (data.encrypted_payload ->
      payload.encrypted_event), fix signature verification (hexdigest/hex ->
      base64), add chat.conversation_join event type, clarify webhook vs stream
      payload shape
    - getting-started.mdx: Fix conversation key access (wrong participant_keys[0]
      .encrypted_key -> correct meta.conversation_key_events), fix send message
      response field (data.id -> data.encoded_message_event), apply same fix in
      complete example send_reply function
    - troubleshooting.mdx: Fix same wrong conversation key access pattern to use
      meta.conversation_key_events + extract_conversation_keys()
    - xchat/introduction.mdx: Add 5 missing endpoints from spec (group create,
      group initialize, conversation keys, add members, get public keys for
      multiple users); fix media download path ({conversation_id} -> {id})
    - xchat/xchat-xdk.mdx: Fix SendPayload type definition to match spec
      (message_id, encoded_message_create_event, encoded_message_event_signature,
      conversation_token); fix send payload comment
    - x-api/activity/introduction.mdx: Add missing chat.conversation_join event
    - openapi.json: Update from version 2.159 to 2.160 with new chat endpoints
      (group conversation, initialize group, conversation keys, add members,
      public key lookup) and schema additions
    - docs.json: Add nav entries for new chat endpoints
    tcaldwell-x committed Mar 23, 2026
    Configuration menu
    Copy the full SHA
    8d5515b View commit details
    Browse the repository at this point in the history
  2. Fix xchat docs: path params, scopes, Flask compat, new chat endpoints

    - Fix 5 x-api/chat endpoint paths: {conversation_id} -> {id} to match
      OpenAPI spec v2.160 (send-message, get-conversation, mark-read,
      typing-indicator, download-media)
    - Add 4 previously untracked x-api/chat endpoint pages
      (add-members, create-group, initialize-group, initialize-keys)
    - Add x-api/users/get-public-keys-for-multiple-users.mdx
    - Fix @app.before_first_request (removed Flask 2.3+) in getting-started.mdx
    - Add media.write to required scopes list in troubleshooting.mdx
    - Fix TypeScript XDK import: 'xdk' -> '@xdevplatform/xdk' in real-time-events.mdx
    tcaldwell-x committed Mar 23, 2026
    Configuration menu
    Copy the full SHA
    74ca5d6 View commit details
    Browse the repository at this point in the history
Loading