# Reporting Documentation Issues

## Bug Reports

If you find issues in the documentation, please report them:

1. Report only **one issue per request**. If you find multiple issues, report them one by one.\
   Only report documentation issues, not software issues or software help requests.
2. Provide the **URL of the page** that has an issue, for example `https://mariadb.com/docs/general-resources/about/readme/reporting-documentation-bugs`.\
   :information\_source: When **reporting via the rating system**, the URL of the page you're on is automatically  included in your response, so there's **no need to include the URL**.
3. Indicate the **nature of the issue**:
   1. **Typo**, for example "known bucks should be known bugs".
   2. **Wrong** information. Provide details of what's wrong. Ideally, point out what the right information should be.
   3. **Missing** information. Provide details of what's missing.
   4. **Unclear** information. Provide details of what's unclear. Ideally, provide a clarification.

## Reporting Channels

Use one of the following channels to report documentation issues. Please don't report software issues via those channels — instructions for doing that are [on this page](https://mariadb.com/docs/general-resources/community/community/bug-tracking/reporting-bugs).

<div align="left"><figure><img src="https://1321769154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCInJQ9cmGjq1lsTG91E%2Fuploads%2Fgit-blob-5ea55449d828fed30c4913baac2bd82c1cf28d76%2Fimage.png?alt=media" alt="Screenshot of the GitBook rating system, with sample text in the text field, and a Submit button." width="221"><figcaption></figcaption></figure></div>

### GitHub Issues

Create a GitHub Issue on <https://github.com/mariadb-corporation/mariadb-docs/issues>.

Alternatively, you could create a pull request on <https://github.com/mariadb-corporation/mariadb-docs/pulls>, fixing the documentation directly.

### Rating system in the right sidebar

This is a super quick way to provide feedback or report issues in the documentation. However, it's one-way communication — we can't provide feedback to you, since we don't know who you are. :innocent:\
:information\_source: Don't paste the URL of the page you're reporting from, since it will automatically be included.

### MariaDB Community Slack

Join the `#documentation` channel in [MariaDB Community Slack](https://r.mariadb.com/join-community-slack). This allows for more detailed feedback or reports, and naturally provides two-way communication.

![Screenshot of the MariaDB Community Slack, with the #documentation channel highlighted.](https://1321769154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCInJQ9cmGjq1lsTG91E%2Fuploads%2Fgit-blob-5aabfee841e83e578d42d4c23bc7dfc8a1403e92%2Fimage.png?alt=media)

<sub>*This page is licensed: CC BY-SA / Gnu FDL*</sub>

{% @marketo/form formId="4316" %}


---

# 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://mariadb.com/docs/general-resources/about/readme/reporting-documentation-bugs.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.