Reporting documentation issues

Found an error, a missing page, or something that's just plain confusing? Documentation issues can be reported via the GitHub repository for these docs.

What counts as a documentation issue?

• Factual errors — incorrect parameter names, wrong defaults, or outdated information
• Typos, grammatical errors, or unclear phrasing
• Missing content — stages, options, or workflows that aren't documented
• Broken links or missing images
• Formatting problems that make content hard to read

Before you report

• Check whether the issue still exists in the latest published docs — it may already be fixed.
• Search the existing issues to avoid duplicates.

How to report

1. Go to the documentation issues page and click "New Issue".
2. Use a short, descriptive title (e.g. "Wrong default value listed for decode_mode in EFM Decoder Sink").
3. In the description, include:
   • The URL or page title where the issue appears
   • A clear description of what is wrong or missing
   • What the correct information should be, if you know it

Contributing a fix

If you'd like to fix the issue yourself, contributions are welcome. See CONTRIBUTING.md for guidance on submitting a pull request.