[{"data":1,"prerenderedAt":144},["ShallowReactive",2],{"kb:\u002Fguides\u002Fgetting-started":3,"kb-search-sections":75,"kb-nav":132},{"id":4,"title":5,"body":6,"description":64,"extension":65,"icon":66,"meta":67,"navigation":68,"order":69,"path":70,"screen":71,"seo":72,"stem":73,"__hash__":74},"guides\u002Fguides\u002Fgetting-started.md","Getting started",{"type":7,"value":8,"toc":57},"minimark",[9,13,22,27,50,54],[10,11,5],"h1",{"id":12},"getting-started",[14,15,16,17,21],"p",{},"Welcome to the knowledge base. Every guide here is a single Markdown file under\n",[18,19,20],"code",{},"content\u002Fguides\u002F",". Add a file, and it automatically appears in the navigation,\nin search, and gets its own shareable URL.",[23,24,26],"h2",{"id":25},"finding-answers","Finding answers",[28,29,30,38,44],"ul",{},[31,32,33,37],"li",{},[34,35,36],"strong",{},"Search"," — use the search box at the top of any knowledge-base page. It\nmatches guide titles, headings and body text.",[31,39,40,43],{},[34,41,42],{},"Browse"," — the left-hand navigation lists every guide.",[31,45,46,49],{},[34,47,48],{},"Contextual help"," — many screens in the product show a small help link that\nbrings you straight to the relevant guide.",[23,51,53],{"id":52},"where-this-fits","Where this fits",[14,55,56],{},"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.",{"title":58,"searchDepth":59,"depth":59,"links":60},"",3,[61,63],{"id":25,"depth":62,"text":26},2,{"id":52,"depth":62,"text":53},"What the knowledge base is and how to find your way around it.","md",null,{},true,1,"\u002Fguides\u002Fgetting-started","home.overview",{"title":5,"description":64},"guides\u002Fgetting-started","ntjwTc6Pt6EexsaQ3_U6iKwnh9viCosv7PcXUicQ9uM",[76,81,85,90,95,97,101,105,108,113,117,122,127],{"id":77,"title":78,"titles":79,"content":80,"level":69},"\u002Fguides\u002Fcontextual-help","Linking help to a screen",[],"Connect any product screen to its guide with one component.",{"id":82,"title":78,"titles":83,"content":84,"level":69},"\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":86,"title":87,"titles":88,"content":89,"level":62},"\u002Fguides\u002Fcontextual-help#how-it-works","How it works",[78],"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.",{"id":91,"title":92,"titles":93,"content":94,"level":62},"\u002Fguides\u002Fcontextual-help#variants","Variants",[78],"\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":70,"title":5,"titles":96,"content":64,"level":69},[],{"id":98,"title":5,"titles":99,"content":100,"level":69},"\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":102,"title":26,"titles":103,"content":104,"level":62},"\u002Fguides\u002Fgetting-started#finding-answers",[5],"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":106,"title":53,"titles":107,"content":56,"level":62},"\u002Fguides\u002Fgetting-started#where-this-fits",[5],{"id":109,"title":110,"titles":111,"content":112,"level":69},"\u002Fguides\u002Fwriting-a-guide","Writing a guide",[],"How to add a new guide to the knowledge base.",{"id":114,"title":110,"titles":115,"content":116,"level":69},"\u002Fguides\u002Fwriting-a-guide#writing-a-guide",[],"Creating a guide takes one file. No code changes required.",{"id":118,"title":119,"titles":120,"content":121,"level":62},"\u002Fguides\u002Fwriting-a-guide#_1-add-a-markdown-file","1. Add a Markdown file",[110],"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":123,"title":124,"titles":125,"content":126,"level":62},"\u002Fguides\u002Fwriting-a-guide#_2-front-matter-fields","2. Front-matter fields",[110],"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":128,"title":129,"titles":130,"content":131,"level":62},"\u002Fguides\u002Fwriting-a-guide#_3-thats-it","3. That's it",[110],"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);}",[133],{"title":134,"path":135,"stem":136,"children":137,"page":143},"Guides","\u002Fguides","guides",[138,140,141],{"title":78,"path":77,"stem":139},"guides\u002Fcontextual-help",{"title":5,"path":70,"stem":73},{"title":110,"path":109,"stem":142},"guides\u002Fwriting-a-guide",false,1781880237132]