Skip to content

Commit

Permalink
Add completion events to walkthrough steps (#1340)
Browse files Browse the repository at this point in the history
Add completion events to walkthrough steps

Ok, upon further investigation, I found out that the `completionEvents`
doesn't actually do anything anymore:
microsoft/vscode#176074 (comment).
However, this no-op is being reverted in next VS Code update in
microsoft/vscode#176074 (comment),
so it's still good to included this here!!! We should then advertise to
people to pls update their VS Code version!!!

You can read more about completion events in
https://code.visualstudio.com/api/references/contribution-points#Completion-events

~~Now we shouldn't auto-mark steps as completed unless command has been
run~~


I also added "CMD/CTRL" to the readme files and renamed the readme files
to be non-capitalized. I also made some content changes in the
walkthrough mardown because it was annoying me, but feel it's better and
more precise.

## Test Plan

This actually has no functional changes at all becuase of
microsoft/vscode#176074 (comment)
until users update the latest VS Code version (which I tried to do but
still doesn't work for me :/ )


https://github.com/lastmile-ai/aiconfig/assets/151060367/d9a74035-1951-4cf7-adbc-4c4b2bcad6c1

Trying on Jupyter notebooks walkthrough also doesn't work for me


https://github.com/lastmile-ai/aiconfig/assets/151060367/39231e92-fe53-41bd-ac4a-cf94725975f5

## Appendix

The timeline for this is pretty wild:
1. Someone doesn't like having checkboxes so removed the functionality
in microsoft/vscode#166747 to automatically
check once a step is viewed. The PR for addressing this was done in Jan
31, 2023: microsoft/vscode#172941
2. People complained about this, so
microsoft/vscode#176074 was filed on March 3,
2023
3. Change for reverting back to original completionEvent feature was
done in January 24, 2024:
microsoft/vscode#203573

---
[//]: # (BEGIN SAPLING FOOTER)
Stack created with [Sapling](https://sapling-scm.com). Best reviewed
with
[ReviewStack](https://reviewstack.dev/lastmile-ai/aiconfig/pull/1340).
* #1346
* #1345
* #1343
* #1341
* __->__ #1340
* #1329
  • Loading branch information
rossdanlm authored Feb 25, 2024
2 parents 144d159 + 4bf8da8 commit 7775a9c
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 12 deletions.
2 changes: 1 addition & 1 deletion vscode-extension/media/ApiKeys.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Set API Keys

> _Tip_: You can use the Command Palette (`CMD`+`Shift`+`P`) to run the command `AIConfig: Set API Keys`
> _Tip_: You can use the Command Palette (`CMD/CTRL + Shift + P`) to run the command `AIConfig: Set API Keys`
You can use AIConfig to run models locally (e.g. LLaMA) or via remote inference API (e.g. GPT-4).
For remote inference, some model providers require an API key to access their inference API (e.g. OpenAI, Google, Anthropic).
Expand Down
2 changes: 1 addition & 1 deletion vscode-extension/media/CreateAIConfig.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Create AIConfig

> _Tip_: You can use the Command Palette (`CMD`+`Shift`+`P`) to run `AIConfig: Create New` to create a new aiconfig anytime.
> _Tip_: You can use the Command Palette (`CMD/CTRL + Shift + P`) to run `AIConfig: Create New` to create a new aiconfig anytime.
You can create the aiconfig in JSON or YAML format. The file defines the models, prompts and settings of your AI workflow.

Expand Down
2 changes: 1 addition & 1 deletion vscode-extension/media/InitializeExtension.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Initialize Extension

> _Tip_: You can use the Command Palette (`CMD`+`Shift`+`P`) to run the command `AIConfig: Initialize Extension`
> _Tip_: You can use the Command Palette (`CMD/CTRL + Shift + P`) to run the command `AIConfig: Initialize Extension`
This installs the `python-aiconfig` package, which is used to run the AIConfig editor and SDK.

Expand Down
2 changes: 1 addition & 1 deletion vscode-extension/media/more.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Find out more!

> _Tip_: Explore all the features of AIConfig Editor by looking for `AIConfig` in the Command Palette.
> _Tip_: Explore all the features of AIConfig Editor by looking for `AIConfig` in the Command Palette (`CMD/CTRL + Shift + P`).
Learn more about generative AI with AIConfig:

Expand Down
24 changes: 16 additions & 8 deletions vscode-extension/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -119,34 +119,42 @@
{
"id": "initializeExtension",
"title": "Initialize Extension",
"description": "Get the extension set up for first use.\n[Initialize Extension](command:vscode-aiconfig.init)",
"description": "Ensure you have everything needed before using the extension for the first time\n[Initialize Extension](command:vscode-aiconfig.init)",
"media": {
"markdown": "media/initializeExtension.md"
}
},
"completionEvents": ["onCommand:vscode-aiconfig.init"]
},
{
"id": "setEnvironment",
"title": "Set API Keys",
"description": "Set up a .env file with the API keys needed to access the models you want to use.\n[Set API Keys](command:vscode-aiconfig.setApiKeys)",
"description": "Define your model API keys in an ``.env`` file\n[Set API Keys](command:vscode-aiconfig.setApiKeys)",
"media": {
"markdown": "media/apiKeys.md"
}
},
"completionEvents": ["onCommand:vscode-aiconfig.setApiKeys"]
},
{
"id": "createAIConfig",
"title": "Create your first AIConfig",
"description": "Let's turn your VS Code into a generative AI studio. \n[Create .aiconfig.yaml](command:vscode-aiconfig.createAIConfigYAML)\nIf you prefer JSON: [Create .aiconfig.json](command:vscode-aiconfig.createAIConfigJSON)",
"description": "Turn your VS Code IDE into a generative AI studio:\n[Create .aiconfig.yaml](command:vscode-aiconfig.createAIConfigYAML)\nIf you prefer JSON:\n[Create .aiconfig.json](command:vscode-aiconfig.createAIConfigJSON)",
"media": {
"markdown": "media/createAIConfig.md"
}
},
"completionEvents": ["onCommand:vscode-aiconfig.createAIConfigYAML", "onCommand:vscode-aiconfig.createAIConfigJSON"]
},
{
"id": "learnMore",
"title": "Find out more",
"description": "Explore all the features of AIConfig Editor by looking for “AIConfig” in the Command Palette (CMD+Shift+P)",
"description": "Explore all the features of the AIConfig Editor by looking for “AIConfig” in the Command Palette (``CMD/CTRL + Shift + P``)",
"media": {
"markdown": "media/more.md"
}
},
"completionEvents": [
"onLink:https://aiconfig.lastmileai.dev/docs/category/overview",
"onLink:https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks",
"onLink:https://discord.com/invite/xBhNKTetGx"
]
}
]
}
Expand Down

0 comments on commit 7775a9c

Please sign in to comment.