Skip to content

docs(examples): add github copilot byok section (cli + vs code)#12

Open
AndreaGriffiths11 wants to merge 1 commit into
helmcode:mainfrom
AndreaGriffiths11:feat/docs-copilot-byok
Open

docs(examples): add github copilot byok section (cli + vs code)#12
AndreaGriffiths11 wants to merge 1 commit into
helmcode:mainfrom
AndreaGriffiths11:feat/docs-copilot-byok

Conversation

@AndreaGriffiths11

Copy link
Copy Markdown

Adds a new section under /docs/examples for using NaN as a BYOK provider in GitHub Copilot CLI and VS Code.

What's added

A new <h2 id="copilot">github copilot (byok)</h2> block inserted between the qwen3.6 and qwen3-embedding model sections, with two subsections:

  • copilot the three env vars (COPILOT_PROVIDER_BASE_URL, COPILOT_PROVIDER_API_KEY, COPILOT_MODEL) plus copilot.cli
  • vs five numbered steps for the Custom Endpoint provider + a ready-to-paste chatLanguageModels.json snippet.code

Both link to upstream docs (Copilot CLI BYOK, VS Code language models).

Model recommendation

Copilot BYOK requires tool calling + streaming. The section lists qwen3.6, deepseek-v4-flash, and mimo-v2.5 as compatible (gemma4 is chat-only).

Verification

  • npm 148/148 passingtest
  • npx astro 0 errors, 0 warningscheck
  • npm run successful Cloudflare Workers buildbuild

Adds a new section under /docs/examples covering Copilot BYOK:
- copilot cli: env vars (COPILOT_PROVIDER_BASE_URL, COPILOT_PROVIDER_API_KEY,
  COPILOT_MODEL) targeting api.nan.builders/v1.
- vs code: step-by-step using the Custom Endpoint provider plus a ready-to-paste
  chatLanguageModels.json snippet.

Notes models that satisfy Copilot's tool-calling + streaming requirement
(qwen3.6, deepseek-v4-flash, mimo-v2.5).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@AndreaGriffiths11

Copy link
Copy Markdown
Author

Preview

Rendered locally against main with the patch applied (npm run dev).

copilot cli subsection

copilot cli

vs code subsection

vs code

Full section + auto-generated TOC

full

copilot cli / vs code automatically.

@AndreaGriffiths11 AndreaGriffiths11 marked this pull request as ready for review June 12, 2026 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant