/v1.5/docs/12_contributing/docs-contribution/Recent content in Documentation Contribution on Porch DocumentationHugoen-us/v1.5/docs/12_contributing/docs-contribution/api-ref-generation/Mon, 01 Jan 0001 00:00:00 +0000/v1.5/docs/12_contributing/docs-contribution/api-ref-generation/<p>Porch uses <code>crd-ref-docs</code> to generate API reference documentation from Go source code.</p> <div class="alert alert-primary" role="alert"><div class="h4 alert-heading" role="heading">Note</div> <p>Only regenerate documentation when API types in <code>api/porch/v1alpha1</code> are modified.</p> </div> <h2 id="prerequisites">Prerequisites</h2><ul> <li>Go 1.25+ installed</li> <li>Access to the Porch repository</li> </ul> <h2 id="generate-documentation">Generate Documentation</h2><p>From the <code>docs/</code> directory:</p> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>make generate-api-docs-markdown </span></span></code></pre></div><p>This runs <code>scripts/generate-api-reference-md.sh</code> which:</p> <ul> <li>Installs <code>crd-ref-docs</code> (v2.0.0) if not present</li> <li>Generates API reference from <code>api/porch/v1alpha1</code></li> <li>Outputs to <code>docs/content/en/docs/7_cli_api/api-ref.md</code></li> </ul> <h2 id="configuration">Configuration</h2><p><strong>Config:</strong> <code>docs/crd-ref-docs/config.yaml</code></p> <ul> <li>Excludes OCI types (not supported)</li> <li>Excludes standard Kubernetes metadata fields</li> <li>Uses Kubernetes v1.34 for API links</li> </ul> <p><strong>Templates:</strong> <code>docs/crd-ref-docs/markdown-templates/</code></p>