Documentation

Documentation

Product docs, workflow guides and troubleshooting should live in one place, so teams do not need to jump between plugin UI guesses and scattered support notes.

Start here

The documentation is meant to support the real product flow: install the plugin, connect a key, analyze a file, understand the result and decide whether you want to fix it automatically or manually.

  • Use Getting Started for installation and the first successful analysis.
  • Use Analyze a File to understand the editor and media-library workflow.
  • Use Fix Audio to understand the repaired-file flow and reanalysis.
  • Use troubleshooting guides when the plugin reports `too loud`, `peak too high` or `dead air`.
  • Use Audacity guides when your team wants to fix audio manually instead of using the repair flow.

How the docs are organized

The docs follow the same mental model as the product:

  • Setup: installation, API key, where the plugin appears.
  • Workflow: upload, analysis, repair, reanalysis and publishing decisions.
  • Troubleshooting: what the findings mean.
  • Manual fixes: practical corrections in external editors like Audacity.
AudioLinter