Skip to content

Documentation

Couldn't find the information you needed, or came across something incorrect, unclear, or outdated? Let us know so we can improve the documentation.

Before creating an issue

Please follow these steps before opening an issue:

  1. Search the project's documentation. Look for the information using the terms you expected. If it was difficult to find, that is useful feedback too.

  2. Find the relevant section. Link to the exact page or section where you found the problem. If something is missing, identify where you expected to find it.

  3. Search the project's issue tracker. An existing issue may already cover the same problem. Subscribe to it to follow the discussion and receive status updates.

If the problem is not covered, create a new documentation issue. The next section explains how to describe it and identify the affected documentation.

Don't know where to start? Ask the community in our free Discord channel or, if you're a Spark member, in a public Spark space. If the information you need to share may be confidential, use your organization's dedicated private space, if available.

Issue template

Our projects use a short template to make documentation issues consistent and efficient for reporters and maintainers. It contains the following parts:

Title

Write a short, specific summary of what is wrong and where. Examples:

  • Installation guide uses an outdated command
  • Navigation reference does not explain section indexes
  • Studio setup page omits Linux requirements

Description

Explain what is incorrect, unclear, outdated, or missing and how it affected your understanding or work. Create separate issues for unrelated problems.

Why we ask: a specific description helps us understand the documentation gap, what you expected to find, and how it affected your work, so we can decide how best to correct it.

Proposed change optional

If you know how the documentation could improve, outline the change or suggest new wording. This is optional; clearly identifying the problem is enough.

Why we ask: a proposed change can clarify the intended outcome, show how you would explain it to other readers, and give us a useful starting point.

Link to the page or section where you found the problem – or where you expected to find missing information. Include documentation or issues, and use a heading link where possible.

Why we ask: direct links help us find the relevant information, understand it in context, and check whether related sections need the same update.

Checklist

Use the checklist for a final review before submitting your issue. Confirm only completed steps and provide any missing information so we can begin the review.