feat: add wireoutput to help

Author: drainpixie

website/help.html

@@ -103,6 +103,53 @@ <h2>Configuration</h2>
       <pre><code>{
     <span class="blue">"checks.typography.symbols.curly_quotes"</span>: <span class="red">false</span>
 }</code></pre>
+
+
+      <h2>Wire Output</h2>
+      <p>
+        <em>Proselint</em> supports structured output for programmatic usage
+        with the <code>--output-format json</code> flag, like so:
+
+        <pre><code><span class="blue">proselint</span> <span class="purple">--output-format</span> <span class="green">json</span> syllabus.md</code></pre>
+      </p>
+
+
+      <p>The output schema is:</p>
+      <pre><code><span class="purple">enum</span> <span class="blue">ErrorCode</span> {
+    <span class="green">Unknown</span> = -31999,
+    <span class="green">FileError</span> = -31998,
+    <span class="green">LintError</span> = -31997,
+}
+
+<span class="purple">interface</span> <span class="blue">ResponseError</span> {
+    <span class="green">code</span>: ErrorCode;
+    <span class="green">message</span>: string;
+    <span class="green">data</span>?: any;
+}
+
+<span class="purple">interface</span> <span class="blue">CheckResult</span> {
+    <span class="green">check_path</span>: string;
+    <span class="green">message</span>: string;
+    <span class="green">span</span>: [number, number];
+    <span class="green">replacements</span>: string | null;
+}
+
+<span class="purple">interface</span> <span class="blue">LintResult</span> <span class="purple">extends</span> <span class="blue">CheckResult</span> {
+    <span class="green">pos</span>: [number, number];
+}
+
+<span class="purple">interface</span> <span class="blue">FileOutput</span> {
+    <span class="green">diagnostics</span>?: LintResult[];
+    <span class="green">error</span>?: ResponseError;
+}
+
+<span class="purple">interface</span> <span class="blue">ProselintOutput</span> {
+    <span class="green">result</span>?: Record&lt;string, FileOutput&gt;;
+    <span class="green">error</span>?: ResponseError;
+}</code></pre>
+
+      <p>Every invocation of <em>proselint</em> produces exactly one <code>ProselintOutput</code> object. Both <code>ProselintOutput</code> and <code>FileOutput</code> are tagged unions. <br /> <br />
+      This means that <code>ProselintOutput</code> will always contain one of <code>result</code> or <code>error</code>, but never both, and the same applies to <code>diagnostics</code> and <code>error</code> for <code>FileOutput</code>.</p>
     </main>
 
     <footer>