# Welcome

Welcome to the VerneMQ documentation! This is a reference guide for most of the available features and options of VerneMQ. The [Getting Started guide](https://docs.vernemq.com/getting-started) might be a good entry point.

The VerneMQ documentation is based on the [VerneMQ Documentation project](https://github.com/vernemq/vmq-docs). Any changes on Github are automatically deployed to the [VerneMQ online Documentation](https://docs.vernemq.com/).

For a more general overview on VerneMQ and MQTT, you might want to start with the [introduction](https://vernemq.com/intro/index.html).

For downloading the subscription-based binary VerneMQ packages and/or a quick description on how to compile VerneMQ from sources, see [Downloads](https://vernemq.com/downloads/index.html).

## How to help improve this documentation

The [VerneMQ Documentation project](https://github.com/vernemq/vmq-docs) is an open-source effort, and your contributions are very welcome and appreciated.\
You can contribute on all levels:

* Language, style and typos
* Fixing obvious documentation errors and gaps
* Providing more details and/or examples for specific topics
* Extending the documentation where you find this useful to do

Note that the documentation is versioned according to the VerneMQ releases. You can click the "Edit on Github" button in the upper right corner of every page to check what branch and document you are on. You can then create a Pull Request (PR) against that branch from your fork of the VerneMQ documentation repository. (Direct edits on Github are possible for members of the documentation repository).


---

# Agent Instructions: 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 current page URL with the `ask` query parameter:

```
GET https://docs.vernemq.com/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
