https://mergewayhq.github.io/docs/project/Recent content in Project on MergewayHugoenhttps://mergewayhq.github.io/docs/project/documentation/Mon, 01 Jan 0001 00:00:00 +0000https://mergewayhq.github.io/docs/project/documentation/<h1 id="documentation-authoring">Documentation authoring<a class="anchor" href="#documentation-authoring"></a></h1> <p>The website uses Hugo Book and organizes canonical documentation by reader need. Put pages under exactly one of <code>tutorials</code>, <code>how-to</code>, <code>reference</code>, or <code>explanation</code>; component hubs orient readers and link to those canonical pages.</p> <h2 id="required-front-matter">Required front matter<a class="anchor" href="#required-front-matter"></a></h2> <p>Every page must define a useful <code>title</code> and <code>description</code>, use <code>type: docs</code>, and set a <code>weight</code> in increments of ten. Section indexes follow the same convention. Use <code>bookToC: true</code> unless a short page has no useful second-level headings. New substantive pages should also declare their <code>mode</code>.</p>https://mergewayhq.github.io/docs/project/github/Mon, 01 Jan 0001 00:00:00 +0000https://mergewayhq.github.io/docs/project/github/<p><a href="https://github.com/mergewayhq/mergeway-cli">GitHub repository</a></p>https://mergewayhq.github.io/docs/project/releases/Mon, 01 Jan 0001 00:00:00 +0000https://mergewayhq.github.io/docs/project/releases/<p><a href="https://github.com/mergewayhq/mergeway-cli/releass">GitHub Releases</a></p>https://mergewayhq.github.io/docs/project/contributing/Mon, 01 Jan 0001 00:00:00 +0000https://mergewayhq.github.io/docs/project/contributing/<h1 id="contributing">Contributing<a class="anchor" href="#contributing"></a></h1> <p>Mergeway accepts changes through its public GitHub repository. Before starting a substantial behavior change, open or find an issue so the intended specification and compatibility impact are visible.</p> <h2 id="prepare-a-change">Prepare a change<a class="anchor" href="#prepare-a-change"></a></h2> <ol> <li>Enter the pinned development environment with <code>devenv shell</code>.</li> <li>Make a focused change with tests at the layer that owns the behavior.</li> <li>Run the relevant focused checks, then <code>make fmt-check</code> and <code>go test ./...</code>.</li> <li>Run <code>make website-check</code> when user behavior, examples, commands, protocols, or documentation change.</li> <li>Explain the user-documentation impact in the pull request, including “no documentation impact” when appropriate.</li> </ol> <p>Detailed prerequisites, package ownership, build/debug commands, release mechanics, and the temporary mdBook/Hugo dual-site workflow live in <a href="https://github.com/mergewayhq/mergeway-cli/blob/main/DEVELOPING.md"><code>DEVELOPING.md</code></a>. Keeping volatile commands there lets this page remain a concise public entry point.</p>https://mergewayhq.github.io/docs/project/license/Mon, 01 Jan 0001 00:00:00 +0000https://mergewayhq.github.io/docs/project/license/<p><a href="https://github.com/mergewayhq/mergeway-cli/blob/main/LICENSE.md">MIT License</a></p>