Report a documentation bug or improvement
Report documentation that is inaccurate, unclear, broken, or missing. You only need to identify the problem; you do not need to investigate the cause or write the fix.
For product or engineering bugs, stories, and requests, use Report a technical ticket.
Open an issue
Open a documentation issue and use a short title that makes the affected topic recognizable. Include:
Type: Bug | Improvement
Page:
Problem:
Use Bug when existing documentation is incorrect, misleading, broken, or no longer matches the product. Use Improvement when documentation is missing or could explain a task more clearly.
The Page may be a URL or page title. Add a screenshot, example, or suggested
wording when it is readily available, but do not delay the report to produce
it.
Do not include credentials, customer data, private links, security details, or other confidential information in a GitHub issue. Use the approved internal security or escalation channel instead.
Submit a fix instead
If you already know the correction, use the Edit this page link at the bottom of the affected page or edit its Markdown file in the repository. Follow the mandatory documentation authoring workflow before opening a pull request.
Expected result
The issue identifies the affected page and explains the problem clearly enough for a maintainer to triage it. A maintainer may ask for one specific detail, link a duplicate, plan a correction, or close the report with an explanation.