[{"data":1,"prerenderedAt":85},["ShallowReactive",2],{"kb-index":3,"kb-search-sections":16,"kb-nav":72},[4,8,12],{"path":5,"title":6,"description":7},"\u002Fguides\u002Fgetting-started","Getting started","What the knowledge base is and how to find your way around it.",{"path":9,"title":10,"description":11},"\u002Fguides\u002Fwriting-a-guide","Writing a guide","How to add a new guide to the knowledge base.",{"path":13,"title":14,"description":15},"\u002Fguides\u002Fcontextual-help","Linking help to a screen","Connect any product screen to its guide with one component.",[17,20,24,30,35,37,41,46,51,53,57,62,67],{"id":13,"title":14,"titles":18,"content":15,"level":19},[],1,{"id":21,"title":14,"titles":22,"content":23,"level":19},"\u002Fguides\u002Fcontextual-help#linking-help-to-a-screen",[],"The knowledge layer can surface the right guide directly inside the product, so\nusers never hit a dead end.",{"id":25,"title":26,"titles":27,"content":28,"level":29},"\u002Fguides\u002Fcontextual-help#how-it-works","How it works",[14],"Give the guide a stable screen key in its front-matter:---\ntitle: Managing invoices\nscreen: billing.invoices\n---\nDrop the ContextualHelp component on the matching screen:\u003CContextualHelp screen=\"billing.invoices\" \u002F> The component looks up the guide whose screen matches and renders a help link\nto it. If no guide matches that key, it renders nothing — so a screen never\nshows a broken help link.",2,{"id":31,"title":32,"titles":33,"content":34,"level":29},"\u002Fguides\u002Fcontextual-help#variants","Variants",[14],"\u003C!-- Custom label -->\n\u003CContextualHelp screen=\"billing.invoices\" label=\"How invoicing works\" \u002F>\n\n\u003C!-- Inline text link inside a sentence -->\nSee \u003CContextualHelp screen=\"billing.invoices\" inline label=\"the invoicing guide\" \u002F>. This page itself is wired to the example.screen key as a live example. html pre.shiki code .sq-ep, html code.shiki .sq-ep{--shiki-default:#005CC5;--shiki-default-font-weight:bold;--shiki-dark:#79B8FF;--shiki-dark-font-weight:bold}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s9eBZ, html code.shiki .s9eBZ{--shiki-default:#22863A;--shiki-dark:#85E89D}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}",{"id":5,"title":6,"titles":36,"content":7,"level":19},[],{"id":38,"title":6,"titles":39,"content":40,"level":19},"\u002Fguides\u002Fgetting-started#getting-started",[],"Welcome to the knowledge base. Every guide here is a single Markdown file under\ncontent\u002Fguides\u002F. Add a file, and it automatically appears in the navigation,\nin search, and gets its own shareable URL.",{"id":42,"title":43,"titles":44,"content":45,"level":29},"\u002Fguides\u002Fgetting-started#finding-answers","Finding answers",[6],"Search — use the search box at the top of any knowledge-base page. It\nmatches guide titles, headings and body text.Browse — the left-hand navigation lists every guide.Contextual help — many screens in the product show a small help link that\nbrings you straight to the relevant guide.",{"id":47,"title":48,"titles":49,"content":50,"level":29},"\u002Fguides\u002Fgetting-started#where-this-fits","Where this fits",[6],"This knowledge layer ships with every SygDev delivery. It is the same building\nblock in every project, so the experience is consistent for your users.",{"id":9,"title":10,"titles":52,"content":11,"level":19},[],{"id":54,"title":10,"titles":55,"content":56,"level":19},"\u002Fguides\u002Fwriting-a-guide#writing-a-guide",[],"Creating a guide takes one file. No code changes required.",{"id":58,"title":59,"titles":60,"content":61,"level":29},"\u002Fguides\u002Fwriting-a-guide#_1-add-a-markdown-file","1. Add a Markdown file",[10],"Create a file under content\u002Fguides\u002F, for example\ncontent\u002Fguides\u002Fexporting-data.md: ---\ntitle: Exporting your data\ndescription: Download your data as CSV or JSON.\norder: 20\n---\n\n# Exporting your data\n\nSteps go here…",{"id":63,"title":64,"titles":65,"content":66,"level":29},"\u002Fguides\u002Fwriting-a-guide#_2-front-matter-fields","2. Front-matter fields",[10],"FieldRequiredPurposetitleyesHeading, navigation label and \u003Ctitle>descriptionnoSEO meta + search snippetscreennoTies the guide to an app screen for contextual helpordernoSort weight within the navigation (lower first)",{"id":68,"title":69,"titles":70,"content":71,"level":29},"\u002Fguides\u002Fwriting-a-guide#_3-thats-it","3. That's it",[10],"On the next build the guide appears in navigation, search and at its own URL\n(\u002Fguides\u002Fexporting-data). Markdown supports headings, tables, code blocks and\nMDC components. html pre.shiki code .sq-ep, html code.shiki .sq-ep{--shiki-default:#005CC5;--shiki-default-font-weight:bold;--shiki-dark:#79B8FF;--shiki-dark-font-weight:bold}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",[73],{"title":74,"path":75,"stem":76,"children":77,"page":84},"Guides","\u002Fguides","guides",[78,80,82],{"title":14,"path":13,"stem":79},"guides\u002Fcontextual-help",{"title":6,"path":5,"stem":81},"guides\u002Fgetting-started",{"title":10,"path":9,"stem":83},"guides\u002Fwriting-a-guide",false,1781880236793]