1"use strict";(globalThis.webpackChunkvoiden_docs=globalThis.webpackChunkvoiden_docs||[]).push([[3318],{4936:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"getting-started-section/getting-started/quick-start","title":"Quick Start","description":"Let\'s send your first request in Voiden. This takes about two minutes \u2014 no configuration, no setup, just a live API call you can see working right away.","source":"@site/docs/getting-started-section/getting-started/quick-start.md","sourceDirName":"getting-started-section/getting-started","slug":"/getting-started-section/getting-started/quick-start","permalink":"/docs/getting-started-section/getting-started/quick-start","draft":false,"unlisted":false,"editUrl":"https://github.com/VoidenHQ/docs/tree/main/docs/getting-started-section/getting-started/quick-start.md","tags":[],"version":"current","lastUpdatedAt":1780577737000,"sidebarPosition":3,"frontMatter":{"id":"quick-start","title":"Quick Start","sidebar_label":"Quick Start","sidebar_position":3},"sidebar":"tutorialSidebar","previous":{"title":"Installation","permalink":"/docs/getting-started-section/getting-started/installation"},"next":{"title":"cURL & Block Import","permalink":"/docs/getting-started-section/getting-started/smart-blocks"}}');var i=s(4848),r=s(8453);const o={id:"quick-start",title:"Quick Start",sidebar_label:"Quick Start",sidebar_position:3},a="Quick Start",d={},c=[{value:"Step 1 \u2014 Create a Request Block",id:"step-1--create-a-request-block",level:2},{value:"Step 2 \u2014 Paste the URL",id:"step-2--paste-the-url",level:2},{value:"Step 3 \u2014 Run the Request",id:"step-3--run-the-request",level:2},{value:"Step 4 \u2014 Read the Response",id:"step-4--read-the-response",level:2},{value:"Step 5 \u2014 Add Some Docs",id:"step-5--add-some-docs",level:2}];function l(e){const t={admonition:"admonition",code:"code",h1:"h1",h2:"h2",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"quick-start",children:"Quick Start"})}),"\n",(0,i.jsx)(t.p,{children:"Let's send your first request in Voiden. This takes about two minutes \u2014 no configuration, no setup, just a live API call you can see working right away."}),"\n",(0,i.jsxs)(t.p,{children:["We'll use ",(0,i.jsx)(t.code,{children:"https://echo.voiden.md"})," \u2014 a simple echo endpoint that reflects back exactly what you send it. Perfect for getting a feel for how Voiden works."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"step-1--create-a-request-block",children:"Step 1 \u2014 Create a Request Block"}),"\n",(0,i.jsxs)(t.p,{children:["Type ",(0,i.jsx)(t.code,{children:"/endpoint"})," anywhere in the editor to insert a new Request Block."]}),"\n",(0,i.jsx)("img",{src:"/img/quick-start/quick-start.png",alt:"Creating a request block",style:{width:"80%",borderRadius:"12px",marginTop:"8px"}}),"\n",(0,i.jsx)(t.admonition,{title:"What's a block?",type:"tip",children:(0,i.jsxs)(t.p,{children:["Everything in Voiden is a block \u2014 requests, docs, environment configs, assertions. Type ",(0,i.jsx)(t.code,{children:"/"})," anywhere to see the full list of available blocks."]})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"step-2--paste-the-url",children:"Step 2 \u2014 Paste the URL"}),"\n",(0,i.jsx)(t.p,{children:"In the URL field, enter:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:"https://echo.voiden.md\n"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"step-3--run-the-request",children:"Step 3 \u2014 Run the Request"}),"\n",(0,i.jsx)(t.p,{children:"Send the request using either:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Keyboard:"})," ",(0,i.jsx)(t.code,{children:"Cmd + Enter"})," on macOS / ",(0,i.jsx)(t.code,{children:"Ctrl + Enter"})," on Windows & Linux"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Mouse:"})," click the green ",(0,i.jsx)(t.strong,{children:"\u25b6 Play"})," button in the toolbar"]}),"\n"]}),"\n",(0,i.jsx)("img",{src:"/img/quick-start/quick-start-post.png",alt:"Sending the request",style:{width:"80%",borderRadius:"12px",marginTop:"8px"}}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"step-4--read-the-response",children:"Step 4 \u2014 Read the Response"}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"Response Panel"})," opens below the block and shows you the full response \u2014 status code, headers, and body. Since this is an echo endpoint, it'll return exactly what you sent."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"step-5--add-some-docs",children:"Step 5 \u2014 Add Some Docs"}),"\n",(0,i.jsx)(t.p,{children:"Here's where Voiden is different. You don't need a separate wiki or README to document this request \u2014 just write directly in the editor, right next to the block."}),"\n",(0,i.jsx)(t.p,{children:"Describe what the endpoint does, what a successful response looks like, edge cases to wat
1ch for \u2014 anything useful. Your docs and your requests live together, stay in sync, and travel with the file."}),"\n",(0,i.jsx)(t.admonition,{title:"Docs as code",type:"info",children:(0,i.jsxs)(t.p,{children:["Voiden treats documentation as a first-class part of your API workflow. Everything lives in ",(0,i.jsx)(t.code,{children:".void"})," files that you can version, share, and diff just like code."]})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.p,{children:"That's your first Voiden request \u2014 clean, simple, and already documented."})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>a});var n=s(6540);const i={},r=n.createContext(i);function o(e){const t=n.useContext(r);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.