July 22, 2024

#product, #engineering

Introducing our new documentation


Blog Screenshot
Author
Mano Toth

Senior Technical Writer

We’re thrilled to announce that we’ve transitioned our documentation to a new platform! This change is designed to enhance your experience, provide more comprehensive resources, and invite greater collaboration from our user community.

Why move to a new documentation platform?

The decision to move was driven by our commitment to providing you with the best possible support and resources. This new documentation platform offers a range of features that align perfectly with our goals:

  • Enhanced user interface. The clean and intuitive design makes it easier for you to find the information you need, and dark mode caters for the needs of those who like photons less.
  • Improved search functionality. Quickly locate the exact documentation you need with powerful search capabilities.
  • Better organization. The new navigation structure helps you explore the docs more easily, catering to both beginners and advanced users.

New features

With our new documentation platform, you’ll benefit from several exciting features:

  • AI-powered chat. Ask anything about Axiom and you’ll receive quick and reliable responses. The accuracy of the responses is ensured by retrieval-augmented generation (RAG) based on our documentation.
  • Interactive API docs. You can now send API requests directly from the documentation. No need to copy and customize cURL commands anymore.
  • Public repository open to user contributions. Separating the documentation from the rest of the website let us transform it into a collaborative space. Leave feedback, suggest edits, and even contribute to the documentation directly.

How you can contribute

We value your input and invite you to help us make our documentation even better. Here’s how you can get involved:

  1. Rate pages. Hit the 👍/👎 button on any page to let us know what you like and what you don’t.
  2. Leave feedback. Use the feedback section on any documentation page to create a GitHub issue where you can share thoughts and suggestions.
  3. Suggest edits. Found a typo or outdated information? You can suggest edits directly on the page.
  4. Contribute content. If you have in-depth knowledge or unique use cases, we encourage you to contribute by writing new sections or enhancing existing ones. For more information, see the contribution guidelines.

Thank you

A special thank you to the Mintlify team for making this transition smooth and efficient. Their platform has significantly improved the way we present our documentation.

Visit our new documentation site.

We’re excited about this new chapter and look forward to your contributions and feedback. Together, we can build a richer, more useful documentation resource for everyone.

Share
Get started with Axiom

Learn how to start ingesting, streaming, and
querying data into Axiom in less than 10 minutes.