Skip to content

Commit

Permalink
[Extention Welcome Page] (#1295)
Browse files Browse the repository at this point in the history
[Extention Welcome Page]

welcome page simplified. Had to add a background to the images becuase
they were not readable on light theme mode. Will revisit the SVG
solution later on
  • Loading branch information
zakariassoul authored Feb 22, 2024
2 parents 33fb852 + b72d665 commit 32307b6
Show file tree
Hide file tree
Showing 14 changed files with 45 additions and 100 deletions.
7 changes: 7 additions & 0 deletions vscode-extension/media/ApiKeys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Set API Keys

Open the Command Palette (CMD+Shift+P) and run the command `AIConfig: Set API Keys`

This step is needed to access generative AI models via model provider API keys, endpoints, tokens (e.g OpenAI API Key). Read more [here](https://aiconfig.lastmileai.dev/docs/getting-started#setup-your-api-keys)

![alt](apiKeys.png)
5 changes: 5 additions & 0 deletions vscode-extension/media/CreateAIConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Create New AIConfig

Open the Command Palette (CMD+Shift+P) and run the command `AIConfig: Create New`

![alt](create.png)
Binary file added vscode-extension/media/Initialize.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added vscode-extension/media/InitializeAiConfig.mp4
Binary file not shown.
Binary file added vscode-extension/media/InitializeDark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions vscode-extension/media/InitializeExtension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Initialize Extension

Open the Command Palette (CMD+Shift+P) and run the command `AIConfig: Initialize`

![alt](Initialize.png)
Binary file added vscode-extension/media/InitializeLight.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added vscode-extension/media/apiKeys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added vscode-extension/media/apiKeyslight.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added vscode-extension/media/create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions vscode-extension/media/more.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Find out more!

Explore all the features of AIConfig Editor by looking for “AIConfig” in the Command Palette (CMD+Shift+P).

Learn more about building with generative AI models with AIConfig:\
[Docs](https://aiconfig.lastmileai.dev/)\
[Cookbooks](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks)\
[Discord](https://discord.com/invite/xBhNKTetGx)

![alt](more.png)
Binary file added vscode-extension/media/more.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
74 changes: 0 additions & 74 deletions vscode-extension/media/welcomePage.md

This file was deleted.

44 changes: 18 additions & 26 deletions vscode-extension/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -105,50 +105,42 @@
"walkthroughs": [
{
"id": "vscode-aiconfig.welcomeWalkthrough",
"title": "Getting Started with AIConfig Editor",
"description": "Get started with some basic commands!",
"title": "AIConfig Editor Getting Started",
"description": "Your first steps to using AIConfig Editor - the generative AI studio for VS Code!",
"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",
"id": "InitializeExtension",
"title": "Initialize Extension",
"description": "Open the Command Palette (CMD+Shift+P) and run the command `AIConfig: Initialize Extension`",
"media": {
"markdown": "media/welcomePage.md"
"markdown": "media/InitializeExtension.md"
}
},
{
"id": "installDependencies",
"title": "Install dependencies",
"description": "This installs the Python libraries required to use the AIConfig editor and SDK",
"id": "ApiKeys",
"title": "Set API Keys",
"description": "This step is needed to access generative AI models via model provider API keys, endpoints, tokens (e.g OpenAI API Key)",
"media": {
"markdown": "media/welcomePage.md"
"markdown": "media/ApiKeys.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\n[Setup Environment Variables](command:vscode-aiconfig.setupEnvironmentVariables)",
"id": "CreateAIConfig",
"title": "Create your first AIConfig",
"description": "Open the Command Palette (CMD+Shift+P) and run the command `AIConfig: Create New (JSON)` or `AIConfig: Create New (YAML)`",
"media": {
"markdown": "media/welcomePage.md"
"markdown": "media/CreateAIConfig.md"
},
"completionEvents": [
"onCommand:vscode-aiconfig.setupEnvironmentVariables"
]
},
{
"id": "createAIConfig",
"title": "Create your first AIConfig",
"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[Create .aiconfig.yaml](command:vscode-aiconfig.createAIConfigYAML)\nIf you prefer JSON:\n[Create .aiconfig.json](command:vscode-aiconfig.createAIConfigJSON)",
"media": {
"markdown": "media/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!",
"id": "more",
"title": "Find out more",
"description": "Explore all the features of AIConfig Editor by looking for “AIConfig” in the Command Palette (CMD+Shift+P)",
"media": {
"markdown": "media/welcomePage.md"
"markdown": "media/more.md"
}
}
]
Expand Down

0 comments on commit 32307b6

Please sign in to comment.