Introducing the Refreshed XMTP Developer Documentation

Fabri
5 min readJun 30, 2023

We are incredibly excited to announce the launch of the completely revamped XMTP developer documentation!

Our mission was clear — to create a seamless and inspiring developer experience by eliminating unnecessary friction and telling a captivating story.

Let’s take a closer look at what’s new on this update of the documentation of XMTP and how it will revolutionize your journey in building chat apps.

Multi-SDK Tabs 🧩

One of our key focuses is interoperability and accessibility. That’s why we’ve taken a multi-SDK approach to our documentation, ensuring that it’s language agnostic. We’ve organized the information into tabbed code sections, ensuring consistency across all SDKs. Whether you’re using Web, Android, or Web, you’ll find a unified and streamlined learning experience.

Core Concepts for Building with XMTP 🏗

To help you get up and running quickly, we’ve distilled the core concepts of building with XMTP into easy-to-follow chapters. Think of it as your favorite TV show guiding you through the integration of secure and private chat into your application. These chapters cover everything from authentication and conversations to messages, streams, attachments, groups, and notifications. Don’t miss out on these essential building blocks for creating amazing chat experiences:

  1. Get started
  2. Authenticate
  3. Conversations
  4. Messages
  5. Streams
  6. Attachments
  7. Groups
  8. Notifications

Left Nav Centralization 📘

We’ve heard your feedback, and we’re thrilled to announce that all our documentation is now centralized within a single Left Nav. Just like chapters in a book, this navigation tool ensures the smoothest learning experience possible when exploring XMTP. With a single tab in your browser, you’ll have access to a comprehensive and consistent learning journey. No more digging through multiple sources or stale information — everything you need is just a click away.

Developer Quickstarts 🚀

Whether you’re a seasoned developer or just starting out, our Quickstarts will take you from 0 to 1 in no time. In just 5–10 minutes, you can have a fully-functioning sample app up and running in your preferred language. We have Quickstarts for NextJS/ReactJS, React Hooks, React Native, Firebase Functions, VueJS / NuxtJS, and NodeJS. These Quickstarts are designed to empower you to hit the ground running and explore the possibilities of XMTP.

Quickstarts 🏁

Use Cases to Spark Your Imagination 💡

To spark your creativity, we’ve organized XMTP around various use cases in Finance, Commerce, Marketing, Automation, Support, and more. Immerse yourself in the possibilities of XMTP and draw inspiration from real-world scenarios. Whether you’re looking to build a secure messaging app, a decentralized social platform, or enhance your marketing efforts, XMTP has you covered. Check out our use cases section and let your imagination run wild!

Categories:

  • Messaging 💬: Build secure peer-to-peer apps or team platforms with end-to-end encryption, media attachments, group chats, and more. Communication reimagined!
  • DeSo 🌿: Step into the world of Decentralized Social with XMTP! Lens Protocol apps trust us for secure messaging. Discover new friends, create groups, share memes, and enjoy a world of possibilities.
  • Marketing 📣: Send secure newsletters to wallet owners, reach NFT collectors & token holders. Engage and analyze with confidence!
  • Support ☎️: Engage in finance transactions on chat, automate with AI bots, and streamline DAO operations — all through secure channels.
  • Commerce 🛍️: Enhance e-commerce with encrypted communication between buyers and sellers.
  • DeFi 🏦: Secure transaction confirmations, notifications, token transfers, NFT minting — XMTP brings security to DeFi.
  • Automation 🤖: Employ secure messaging for web3 automation tools, including triggers, notifications, and customer service bots.

Culture and Brand Inspired Re-styling 🎨

At XMTP, we believe in reflecting our vibrant culture and unique brand identity in everything we do. That’s why our revamped documentation features a fresh and visually stunning design. Our new design ethos not only emphasizes innovation but also ensures an intuitive and immersive user experience. Get ready to be inspired by our vibrant and engaging visual language.

Tutorials: The Developer’s Arsenal 🛠

Our tutorials have undergone a transformation, now offering technical deep-dives into integration partners, highlighting use cases, and providing in-depth education on specific concepts. These tutorials are packed with code examples and designed for rapid deployment, making them perfect for developers looking to experiment and showcase the true potential of XMTP. Discover tutorials on performance optimization, optimistic sending, identity resolution, broadcasts, chat bots, and much more.

Language Simplification 🗣

We’ve taken a simplified approach to our language to ensure clarity and ease of understanding. For example, instead of using terms like Preview, Dev Preview, and General Availability, we now use the more straightforward terms Alpha, Beta, and Production. In addition, we've merged many independent docs into traditional Developer FAQs, making it easier for you to find the information you need.

Hackathons Hub 🏁

If you’re a hackathon enthusiast, we have a dedicated Hackathons Hub just for you. This hub is the go-to resource for showcasing the possibilities of XMTP and keeping up with the latest hackathons. We update this section regularly, providing a centralized space for encouragement, inspiration, and collaboration.

We owe a huge thanks to our incredible XMTP community and the exceptional team behind the protocol. Building this documentation has been an absolute joy! We can’t wait to see the innovative chat apps you’ll create with XMTP 🚀

--

--

Fabri

I like software ecosystems. ⚡️ DevRel @xmtp_ ⚡️