> For the complete documentation index, see [llms.txt](https://docs.warpstream.com/warpstream/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.warpstream.com/warpstream/overview/readme.md).

# Introduction

The official documentation for WarpStream, a diskless, Apache Kafka-compatible data streaming platform built directly on top of cloud object stores such as S3.

Welcome to the documentation for WarpStream, a diskless data streaming platform designed to seamlessly integrate with cloud object stores such as S3, GCP, and Azure while remaining compatible with Apache Kafka.

To learn more, we recommend reviewing our documentation in the following order:

1. [WarpStream architecture](/warpstream/overview/architecture.md) to learn the basic principals of how WarpStream works.
2. Run the [WarpStream demo](/warpstream/getting-started/install-the-warpstream-agent.md) to see the product in action.

Finally once you're ready to deploy WarpStream to one of your live environments, you can create a free WarpStream account by going to <https://console.warpstream.com/signup> and then follow our documentation to [deploy the Agents](/warpstream/agent-setup/deploy.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.warpstream.com/warpstream/overview/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.