2 lines
2.7 KiB
JavaScript
2 lines
2.7 KiB
JavaScript
import{_ as a,o as t,c as o,a2 as r}from"./chunks/framework.B8zgMDLd.js";const u=JSON.parse('{"title":"Docs Maintenance","description":"","frontmatter":{},"headers":[],"relativePath":"reference/docs-maintenance.md","filePath":"reference/docs-maintenance.md"}'),n={name:"reference/docs-maintenance.md"};function i(s,e,l,d,c,h){return t(),o("div",null,[...e[0]||(e[0]=[r('<h1 id="docs-maintenance" tabindex="-1">Docs Maintenance <a class="header-anchor" href="#docs-maintenance" aria-label="Permalink to "Docs Maintenance""></a></h1><p>The public docs live in the app repo so documentation changes can ship with behavior changes.</p><h2 id="update-docs-when-you-change" tabindex="-1">Update Docs When You Change <a class="header-anchor" href="#update-docs-when-you-change" aria-label="Permalink to "Update Docs When You Change""></a></h2><ul><li>A Tauri command.</li><li>A new component or hook that changes user behavior.</li><li>A data model or frontmatter convention.</li><li>Git, AI, onboarding, or release behavior.</li><li>Public release pages, download metadata, or updater channels.</li><li>Platform support.</li><li>Keyboard shortcuts.</li></ul><h2 id="suggested-workflow" tabindex="-1">Suggested Workflow <a class="header-anchor" href="#suggested-workflow" aria-label="Permalink to "Suggested Workflow""></a></h2><ol><li>Make the code change.</li><li>Update the matching concept, guide, or reference page.</li><li>Add a troubleshooting page if the change creates a new failure mode.</li><li>Run <code>pnpm docs:build</code>.</li><li>Check the home page, search, release/download links, and changed docs pages in a browser.</li></ol><h2 id="page-types" tabindex="-1">Page Types <a class="header-anchor" href="#page-types" aria-label="Permalink to "Page Types""></a></h2><table tabindex="0"><thead><tr><th>Type</th><th>Purpose</th></tr></thead><tbody><tr><td>Start</td><td>Helps a new user get into the app.</td></tr><tr><td>Concepts</td><td>Explains mental models.</td></tr><tr><td>Guides</td><td>Teaches workflows.</td></tr><tr><td>Reference</td><td>Gives stable facts and tables.</td></tr><tr><td>Troubleshooting</td><td>Starts from a symptom and ends with recovery.</td></tr></tbody></table><h2 id="review-checklist" tabindex="-1">Review Checklist <a class="header-anchor" href="#review-checklist" aria-label="Permalink to "Review Checklist""></a></h2><ul><li>Does the page describe current behavior?</li><li>Does it mention macOS primary and Windows/Linux supported-early status when platform support matters?</li><li>Are links relative and VitePress-compatible?</li><li>Can a user discover the page with local search?</li></ul>',10)])])}const m=a(n,[["render",i]]);export{u as __pageData,m as default};
|