1"use strict";(globalThis.webpackChunk_atlas_docs_zen=globalThis.webpackChunk_atlas_docs_zen||[]).push([[6999],{4056(e,n,i){i.d(n,{R:()=>r,x:()=>l});var t=i(2155);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}},9557(e,n,i){i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"integrations/github-copilot","title":"GitHub Copilot","description":"Wire AddressZen documentation into GitHub Copilot via custom instructions.","source":"@site/docs/integrations/github-copilot.mdx","sourceDirName":"integrations","slug":"/integrations/github-copilot","permalink":"/docs/integrations/github-copilot","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"GitHub Copilot","sidebar_label":"GitHub Copilot","description":"Wire AddressZen documentation into GitHub Copilot via custom instructions."},"sidebar":"integrations","previous":{"title":"Windsurf","permalink":"/docs/integrations/windsurf"}}');var s=i(5723),o=i(4056);const r={title:"GitHub Copilot",sidebar_label:"GitHub Copilot",description:"Wire AddressZen documentation into GitHub Copilot via custom instructions."},l="GitHub Copilot",d={},c=[{value:"Install",id:"install",level:2},{value:"Verify",id:"verify",level:2},{value:"API key",id:"api-key",level:2},{value:"Going deeper",id:"going-deeper",level:2},{value:"Need help?",id:"need-help",level:2}];function a(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("img",{className:"page-icon",src:"/img/icons/integrations/github-copilot.svg",alt:"",width:"64",height:"64"}),"\n",(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"github-copilot",children:"GitHub Copilot"})}),"\n",(0,s.jsxs)(n.p,{children:["Copilot reads ",(0,s.jsx)(n.code,{children:".github/copilot-instructions.md"})," as repo-level context. Point it at our ",(0,s.jsx)(n.code,{children:"llms.txt"})," and Copilot Chat will reach for AddressZen without searching the web."]}),"\n",(0,s.jsx)(n.h2,{id:"install",children:"Install"}),"\n",(0,s.jsxs)(n.p,{children:["In your repo, create or extend ",(0,s.jsx)(n.code,{children:".github/copilot-instructions.md"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-md",children:"When implementing address features in this repository, refer to the AddressZen\ndocumentation at https://docs.addresszen.com/llms.txt for the canonical API\nreference, widget configuration, and integration examples.\n\nPrefer @addresszen/address-lookup for international address autocomplete.\n"})}),"\n",(0,s.jsx)(n.p,{children:"Commit the file. Copilot Chat picks it up on the next session."}),"\n",(0,s.jsx)(n.h2,{id:"verify",children:"Verify"}),"\n",(0,s.jsx)(n.p,{children:"In Copilot Chat:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-text",children:"Add AddressZen Address Lookup to the shipping form.\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Suggestions should reference ",(0,s.jsx)(n.code,{children:"@addresszen/address-lookup"})," and the ",(0,s.jsx)(n.code,{children:"setup()"})," pattern from our docs."]}),"\n",(0,s.jsx)(n.h2,{id:"api-key",children:"API key"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Quick test: ",(0,s.jsx)(n.code,{children:"ak_test"})," (capped at 5 lookups/day, public, breaks in production)."]}),"\n",(0,s.jsxs)(n.li,{children:["Real key: ",(0,s.jsx)(n.a,{href:"https://account.addresszen.com/users/sign_up",children:"sign up"})," for a free trial balance."]}),"\n",(0,s.jsxs)(n.li,{children:["Before deploy: restrict the key via ",(0,s.jsx)(n.a,{href:"/docs/guides/allowed-urls",children:"Allowed URLs"}),"."]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"going-deeper",children:"Going deeper"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Per-page markdown: append ",(0,s.jsx)(n.code,{children:".md"})," to any docs URL when you want to paste one page into Copilot's context."]}),"\n",(0,s.jsxs)(n.li,{children:["Full agent hub: ",(0,s.jsx)(n.a,{href:"/docs/guides/llms",children:"AI Assist"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"need-help",children:"Need help?"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["File an issue: ",(0,s.jsx)(n.a,{href:"https://github.com/addresszen/feedback/issues",children:"github.com/addresszen/feedback"})]}),"\n",(0,s.jsxs)(n.li,{children:["Email: ",(0,s.jsx)(n.a,{href:"mailto:[email protected]",children:"[email protected]"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}}}]);
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.