From 120e480b2dcd19b66b6fbfdec8ef618d91ec39f5 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Fri, 6 Nov 2026 12:43:42 -0500 Subject: [PATCH] docs: README and CHANGELOG --- .gitignore | 2 ++ CHANGELOG.md | 31 ++++++++++++++++++---- README.md | 75 +++++++--------------------------------------------- 3 files changed, 37 insertions(+), 71 deletions(-) diff --git a/.gitignore b/.gitignore index 0b60dfa..0d49789 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,5 @@ dist node_modules .vscode-test/ *.vsix + +.env diff --git a/CHANGELOG.md b/CHANGELOG.md index 1f5fa11..a2befe8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,30 @@ -# Change Log +# Changelog -All notable changes to the "inference-coop-copilot" extension will be documented in this file. +## [0.0.1] - 2026-11-06 -Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file. +Initial development release. Not yet functional for chat. -## [Unreleased] +### Added -- Initial release \ No newline at end of file +- Extension scaffold with esbuild build pipeline and ESLint/tsc checks. +- Registration of a `LanguageModelChatProvider` under the `inference-coop` + vendor, discoverable via `contributes.languageModelChatProviders`. +- Model discovery: fetches `GET https://gateway.inference.coop/v1/models` + and filters to chat-capable models, excluding image-generation and + audio endpoints. +- `inferenceCoop.apiKey` setting (plain text, temporarily). +- "Inference Coop" output channel logging provider activation, model + enumeration, and HTTP status codes. + +### Known issues + +- Models appear in the Language Models panel but not in the Copilot Chat + model picker. Under investigation; suspected upstream VS Code issue. +- `provideLanguageModelChatResponse` sends a streaming request but has not + been verified end to end from the chat UI. +- No tool calling, image input, or token counting (returns 0). +- API key is stored in settings rather than `SecretStorage`. + +### Not yet published + +- No Marketplace publisher registered; installed from a local `.vsix`. diff --git a/README.md b/README.md index c9156d3..2caab7e 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,14 @@ -# inference-coop-copilot README +# Inference Coop (unofficial) -This is the README for your extension "inference-coop-copilot". After writing up a brief description, we recommend including the following sections. +Community-built model provider for [inference.coop](https://inference.coop), +usable in GitHub Copilot Chat. Not affiliated with or endorsed by the +Inference Cooperative. -## Features +## Setup -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. +1. Set `inferenceCoop.apiKey` in your settings to your co-op API key. +2. Open Copilot Chat and pick an `inference-coop/…` model. -For example if there is an image subfolder under your extension project workspace: +## Status -\!\[feature X\]\(images/feature-x.png\) - -> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. - -## Requirements - -If you have any requirements or dependencies, add a section describing those and how to install and configure them. - -## Extension Settings - -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. - -For example: - -This extension contributes the following settings: - -* `myExtension.enable`: Enable/disable this extension. -* `myExtension.thing`: Set to `blah` to do something. - -## Known Issues - -Calling out known issues can help limit users opening duplicate issues against your extension. - -## Release Notes - -Users appreciate release notes as you update your extension. - -### 1.0.0 - -Initial release of ... - -### 1.0.1 - -Fixed issue #. - -### 1.1.0 - -Added features X, Y, and Z. - ---- - -## Following extension guidelines - -Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension. - -* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) - -## Working with Markdown - -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: - -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux). -* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux). -* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets. - -## For more information - -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) - -**Enjoy!** +Early development. Text chat only so far; tool calling is not implemented.