Skip to content

Commit

Permalink
[RFC] Initial walkthrough content for VS Code extension (#1273)
Browse files Browse the repository at this point in the history
[RFC] Initial walkthrough content for VS Code extension

Following the guide from VSCode tutorials here:
https://code.visualstudio.com/api/references/contribution-points#contributes.walkthroughs

This is now just extremely barebones, want to get some comments on what
other commands we feel should be included.

Also note that I can also add in images and markdown to the right side
of panel for each item that's selected

Let's just get this out really quickly so that Tanya + Zak can help out
with content + graphics in the markdown files

## Test Plan


https://github.com/lastmile-ai/aiconfig/assets/151060367/5827b98c-ac1c-4454-a337-ce9eb3c44b1a
  • Loading branch information
rossdanlm authored Feb 21, 2024
2 parents 8f1bf49 + b0a7e73 commit 91f4c74
Showing 1 changed file with 50 additions and 1 deletion.
51 changes: 50 additions & 1 deletion vscode-extension/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,56 @@
"workbench.editorAssociations": {
"{git,gitlens,sapling-diff}:/**/*.{aiconfig.json, aiconfig.yaml}": "default"
}
}
},
"walkthroughs": [
{
"id": "vscode-aiconfig.welcomeWalkthrough",
"title": "Getting Started with AIConfig Editor",
"description": "Get started with some basic commands!",
"steps": [
{
"id": "selectInterpreter",
"title": "Select your Python Interpreter",
"description": "This defines the Python environment that you will use in your VS Code session. It keeps track of which modules you've installed",
"media": {
"markdown": "src/welcomePage.md"
}
},
{
"id": "installDependencies",
"title": "Install dependencies",
"description": "This installs the Python libraries required to use the AIConfig editor and SDK",
"media": {
"markdown": "src/welcomePage.md"
}
},
{
"id": "setupEnvironmentVariables",
"title": "Setup Environment Variables",
"description": "This creates an .env file (or uses it if it already exists) to define environment varialbes needed to run AI models. Ex: OpenAI models read from the `OPENAI_API_KEY` variable",
"media": {
"markdown": "src/welcomePage.md"
}
},
{
"id": "createAIConfig",
"title": "Create an AIConfig file",
"description": "You can do this either in JSON or YAML format. This file defines the AI models and workflow you want to use in your project.\n[JSON](command:vscode-aiconfig.createAIConfigJSON) [YAML](command:vscode-aiconfig.createAIConfigYAML)",
"media": {
"markdown": "src/welcomePage.md"
}
},
{
"id": "showWelcome",
"title": "[Optional] Read full tutorial",
"description": "Read the full tutorial on the [Welcome page](command:vscode-aiconfig.showWelcome) to learn about all the things you can do with AIConfig!",
"media": {
"markdown": "src/welcomePage.md"
}
}
]
}
]
},
"scripts": {
"vscode:prepublish": "yarn run compile",
Expand Down

0 comments on commit 91f4c74

Please sign in to comment.