Skip to content

Commit fad79b6

Browse files
authored
Merge pull request #586 from Cloud-Code-AI/582-feat-add-a-vs-code-extension
docs: update README and configuration for clarity
2 parents e4d967d + 7779fdf commit fad79b6

File tree

3 files changed

+10
-69
lines changed

3 files changed

+10
-69
lines changed

extensions/vscode/.vscodeignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.vscode/**
22
.vscode-test/**
3-
out/**
3+
# out/**
44
node_modules/**
55
src/**
66
.gitignore

extensions/vscode/README.md

+3-67
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,7 @@
11
# kaizen-cloudcode README
22

3-
This is the README for your extension "kaizen-cloudcode". After writing up a brief description, we recommend including the following sections.
4-
3+
This is the main API endpoint of Kaizen-CloudCode.
54
## Features
65

7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
8-
9-
For example if there is an image subfolder under your extension project workspace:
10-
11-
\!\[feature X\]\(images/feature-x.png\)
12-
13-
> 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.
14-
15-
## Requirements
16-
17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
18-
19-
## Extension Settings
20-
21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
22-
23-
For example:
24-
25-
This extension contributes the following settings:
26-
27-
* `myExtension.enable`: Enable/disable this extension.
28-
* `myExtension.thing`: Set to `blah` to do something.
29-
30-
## Known Issues
31-
32-
Calling out known issues can help limit users opening duplicate issues against your extension.
33-
34-
## Release Notes
35-
36-
Users appreciate release notes as you update your extension.
37-
38-
### 1.0.0
39-
40-
Initial release of ...
41-
42-
### 1.0.1
43-
44-
Fixed issue #.
45-
46-
### 1.1.0
47-
48-
Added features X, Y, and Z.
49-
50-
---
51-
52-
## Following extension guidelines
53-
54-
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
55-
56-
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
57-
58-
## Working with Markdown
59-
60-
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
61-
62-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
63-
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
64-
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
65-
66-
## For more information
67-
68-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
69-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
70-
71-
**Enjoy!**
6+
1. API Management:
7+
Manage all your API's in a single place!

extensions/vscode/package.json

+6-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
"displayName": "kaizen-cloudcode",
44
"description": "AI powered tool to automate your day to day development tasks",
55
"version": "0.0.1",
6+
"publisher": "CloudCodeAI",
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/Clouod-Code-AI/kaizen.git"
10+
},
611
"engines": {
712
"vscode": "^1.93.0"
813
},
@@ -27,7 +32,7 @@
2732
"activitybar": [
2833
{
2934
"id": "kaizen-cloudcode-view",
30-
"title": "Your Extension",
35+
"title": "Kaizen by CloudCode AI",
3136
"icon": "media/logo.png"
3237
}
3338
]

0 commit comments

Comments
 (0)