Skip to content

Reporting a Bug

If you encounter an issue or unexpected behavior in the documentation or the website, please follow these steps to help us resolve the problem efficiently.

Before Reporting

  • Search Existing Issues: Check the issues page to see if the bug has already been reported.

  • Reproduce the Bug: Ensure that it is reproducible by following these steps:

  • Clear your browser cache.
  • Open the documentation site in an incognito/private window.
  • Verify the issue persists.

How to Report

When you are ready to report the bug, please include the following details:

  • Title: A short and descriptive title of the issue.

  • Description: A detailed description of the bug, including:

  • What you expected to happen.
  • What actually happened.

  • Any error messages or screenshots, if applicable.

  • Steps to Reproduce: A step-by-step guide to reproduce the issue:

  • The URL or page where the bug occurs.
  • The actions you performed.

  • Any additional context (browser, operating system, etc.).

  • Environment Information: Provide details such as:

  • Browser and version.
  • Operating system.

  • Documentation version (if applicable).

  • Additional Information: Any other context or logs that might be helpful in diagnosing the issue.

Submitting Your Report

Once you've gathered all the necessary information, submit your report as an issue on our GitHub repository.

Thank you for helping us improve the documentation!