Skip to content

Reporting a Docs Issue

Great documentation depends on community feedback. Use this guide to flag typos, confusing explanations, or missing coverage in the Go Advanced Admin docs.

Review Before Filing

  • Search first: Check the open documentation issues to avoid duplicates.
  • Confirm the scope: Make sure the problem lives in the documentation rather than the product itself. Bugs in the code should be reported through the bug report process.
  • Collect references: Note the page URL, section heading, and any relevant screenshots or command output.

Submit a Documentation Issue

  1. Open the documentation issue template.
  2. Provide a descriptive title that highlights the problem (e.g., "Typo in Applications guide" or "Missing section on Fiber middleware").
  3. Fill in the template fields:
  4. Affected page(s): Link directly to the doc page(s) you are referencing.
  5. Issue type: Clarify whether this is a typo, missing content, outdated instructions, etc.
  6. Suggested fix: Explain what you expected to find or propose wording if you have it.
  7. Additional context: Attach screenshots or logs if they help clarify the issue.
  8. Submit the issue so maintainers or community contributors can pick it up.

Follow Up

  • Keep an eye on notifications in case maintainers request more information.
  • If you are comfortable proposing a fix yourself, mention that you plan to open a documentation pull request.
  • Once the correction is merged, confirm the issue can be closed.

Thanks for helping us keep the documentation accurate and friendly for everyone!