[{"data":1,"prerenderedAt":283},["ShallowReactive",2],{"kb:\u002Fguides\u002Fwriting-a-guide":3,"kb-search-sections":215,"kb-nav":271},{"id":4,"title":5,"body":6,"description":208,"extension":39,"icon":209,"meta":210,"navigation":81,"order":54,"path":211,"screen":209,"seo":212,"stem":213,"__hash__":214},"guides\u002Fguides\u002Fwriting-a-guide.md","Writing a guide",{"type":7,"value":8,"toc":203},"minimark",[9,13,17,22,34,100,104,180,184,199],[10,11,5],"h1",{"id":12},"writing-a-guide",[14,15,16],"p",{},"Creating a guide takes one file. No code changes required.",[18,19,21],"h2",{"id":20},"_1-add-a-markdown-file","1. Add a Markdown file",[14,23,24,25,29,30,33],{},"Create a file under ",[26,27,28],"code",{},"content\u002Fguides\u002F",", for example\n",[26,31,32],{},"content\u002Fguides\u002Fexporting-data.md",":",[35,36,41],"pre",{"className":37,"code":38,"language":39,"meta":40,"style":40},"language-md shiki shiki-themes github-light github-dark","---\ntitle: Exporting your data\ndescription: Download your data as CSV or JSON.\norder: 20\n---\n\n# Exporting your data\n\nSteps go here…\n","md","",[26,42,43,52,59,65,71,76,83,89,94],{"__ignoreMap":40},[44,45,48],"span",{"class":46,"line":47},"line",1,[44,49,51],{"class":50},"sq-ep","---\n",[44,53,55],{"class":46,"line":54},2,[44,56,58],{"class":57},"sVt8B","title: Exporting your data\n",[44,60,62],{"class":46,"line":61},3,[44,63,64],{"class":57},"description: Download your data as CSV or JSON.\n",[44,66,68],{"class":46,"line":67},4,[44,69,70],{"class":57},"order: 20\n",[44,72,74],{"class":46,"line":73},5,[44,75,51],{"class":50},[44,77,79],{"class":46,"line":78},6,[44,80,82],{"emptyLinePlaceholder":81},true,"\n",[44,84,86],{"class":46,"line":85},7,[44,87,88],{"class":50},"# Exporting your data\n",[44,90,92],{"class":46,"line":91},8,[44,93,82],{"emptyLinePlaceholder":81},[44,95,97],{"class":46,"line":96},9,[44,98,99],{"class":57},"Steps go here…\n",[18,101,103],{"id":102},"_2-front-matter-fields","2. Front-matter fields",[105,106,107,123],"table",{},[108,109,110],"thead",{},[111,112,113,117,120],"tr",{},[114,115,116],"th",{},"Field",[114,118,119],{},"Required",[114,121,122],{},"Purpose",[124,125,126,143,156,168],"tbody",{},[111,127,128,134,137],{},[129,130,131],"td",{},[26,132,133],{},"title",[129,135,136],{},"yes",[129,138,139,140],{},"Heading, navigation label and ",[26,141,142],{},"\u003Ctitle>",[111,144,145,150,153],{},[129,146,147],{},[26,148,149],{},"description",[129,151,152],{},"no",[129,154,155],{},"SEO meta + search snippet",[111,157,158,163,165],{},[129,159,160],{},[26,161,162],{},"screen",[129,164,152],{},[129,166,167],{},"Ties the guide to an app screen for contextual help",[111,169,170,175,177],{},[129,171,172],{},[26,173,174],{},"order",[129,176,152],{},[129,178,179],{},"Sort weight within the navigation (lower first)",[18,181,183],{"id":182},"_3-thats-it","3. That's it",[14,185,186,187,190,191,198],{},"On the next build the guide appears in navigation, search and at its own URL\n(",[26,188,189],{},"\u002Fguides\u002Fexporting-data","). Markdown supports headings, tables, code blocks and\n",[192,193,197],"a",{"href":194,"rel":195},"https:\u002F\u002Fcontent.nuxt.com\u002Fdocs\u002Ffiles\u002Fmarkdown",[196],"nofollow","MDC"," components.",[200,201,202],"style",{},"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);}",{"title":40,"searchDepth":61,"depth":61,"links":204},[205,206,207],{"id":20,"depth":54,"text":21},{"id":102,"depth":54,"text":103},{"id":182,"depth":54,"text":183},"How to add a new guide to the knowledge base.",null,{},"\u002Fguides\u002Fwriting-a-guide",{"title":5,"description":208},"guides\u002Fwriting-a-guide","VOjDOO2eKrhwM-IkjXKpTE54IpBexwbpDbtn3NJ5x0o",[216,221,225,230,235,240,244,249,254,256,259,263,267],{"id":217,"title":218,"titles":219,"content":220,"level":47},"\u002Fguides\u002Fcontextual-help","Linking help to a screen",[],"Connect any product screen to its guide with one component.",{"id":222,"title":218,"titles":223,"content":224,"level":47},"\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":226,"title":227,"titles":228,"content":229,"level":54},"\u002Fguides\u002Fcontextual-help#how-it-works","How it works",[218],"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":231,"title":232,"titles":233,"content":234,"level":54},"\u002Fguides\u002Fcontextual-help#variants","Variants",[218],"\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":236,"title":237,"titles":238,"content":239,"level":47},"\u002Fguides\u002Fgetting-started","Getting started",[],"What the knowledge base is and how to find your way around it.",{"id":241,"title":237,"titles":242,"content":243,"level":47},"\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":245,"title":246,"titles":247,"content":248,"level":54},"\u002Fguides\u002Fgetting-started#finding-answers","Finding answers",[237],"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":250,"title":251,"titles":252,"content":253,"level":54},"\u002Fguides\u002Fgetting-started#where-this-fits","Where this fits",[237],"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":211,"title":5,"titles":255,"content":208,"level":47},[],{"id":257,"title":5,"titles":258,"content":16,"level":47},"\u002Fguides\u002Fwriting-a-guide#writing-a-guide",[],{"id":260,"title":21,"titles":261,"content":262,"level":54},"\u002Fguides\u002Fwriting-a-guide#_1-add-a-markdown-file",[5],"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":264,"title":103,"titles":265,"content":266,"level":54},"\u002Fguides\u002Fwriting-a-guide#_2-front-matter-fields",[5],"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":268,"title":183,"titles":269,"content":270,"level":54},"\u002Fguides\u002Fwriting-a-guide#_3-thats-it",[5],"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);}",[272],{"title":273,"path":274,"stem":275,"children":276,"page":282},"Guides","\u002Fguides","guides",[277,279,281],{"title":218,"path":217,"stem":278},"guides\u002Fcontextual-help",{"title":237,"path":236,"stem":280},"guides\u002Fgetting-started",{"title":5,"path":211,"stem":213},false,1781880237134]