Skip to content

Commit e8fc38f

Browse files
✨ Add Welcome Page and Update Icons (#25)
1 parent 00aaa0b commit e8fc38f

8 files changed

Lines changed: 92 additions & 3 deletions

File tree

media/icons/logo-teal.svg

Lines changed: 17 additions & 0 deletions
Loading

media/icons/logo-white.svg

Lines changed: 4 additions & 0 deletions
Loading

media/walkthrough/codelens.gif

3.57 MB
Loading

media/walkthrough/configure.gif

1.96 MB
Loading

media/walkthrough/endpoints.gif

2.62 MB
Loading

media/walkthrough/feedback.gif

641 KB
Loading

media/walkthrough/search.gif

2.28 MB
Loading

package.json

Lines changed: 71 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "fastapi-vscode",
33
"displayName": "FastAPI Extension",
44
"description": "VS Code extension for FastAPI development",
5-
"version": "0.0.2",
5+
"version": "0.0.4",
66
"publisher": "FastAPILabs",
77
"license": "MIT",
88
"repository": {
@@ -114,18 +114,86 @@
114114
{
115115
"id": "fastapi",
116116
"title": "FastAPI",
117-
"icon": "$(zap)"
117+
"icon": "media/icons/logo-white.svg"
118118
}
119119
]
120120
},
121121
"views": {
122122
"fastapi": [
123123
{
124124
"id": "endpoint-explorer",
125-
"name": "Endpoint Explorer"
125+
"name": "Endpoint Explorer",
126+
"icon": "media/icons/logo-white.svg"
126127
}
127128
]
128129
},
130+
"viewsWelcome": [
131+
{
132+
"view": "endpoint-explorer",
133+
"contents": "No FastAPI apps found in this workspace.\n\n[Configure Entry Point](command:workbench.action.openSettings?[\"fastapi.entryPoint\"])\n\n[Open Getting Started](command:workbench.action.openWalkthrough?{\"category\":\"FastAPILabs.fastapi-vscode#fastapi-getting-started\"})"
134+
}
135+
],
136+
"walkthroughs": [
137+
{
138+
"id": "fastapi-getting-started",
139+
"title": "Get Started with FastAPI",
140+
"description": "Learn how to use the FastAPI extension to boost your productivity",
141+
"icon": "media/icons/logo-teal.svg",
142+
"steps": [
143+
{
144+
"id": "view-endpoints",
145+
"title": "View Your API Endpoints",
146+
"description": "Open the Endpoint Explorer in the Activity Bar (⚡) to see all routes in your FastAPI application.\n[Open Endpoint Explorer](command:endpoint-explorer.focus)",
147+
"media": {
148+
"image": "media/walkthrough/endpoints.gif",
149+
"altText": "Endpoint Explorer showing FastAPI routes organized by router"
150+
},
151+
"completionEvents": [
152+
"onView:endpoint-explorer"
153+
]
154+
},
155+
{
156+
"id": "search-endpoints",
157+
"title": "Quickly Find Endpoints",
158+
"description": "Instantly filter and navigate to any endpoint in your application.\n[Search Endpoints](command:fastapi-vscode.searchEndpoints)",
159+
"media": {
160+
"image": "media/walkthrough/search.gif",
161+
"altText": "Search endpoints quick pick showing filtered results"
162+
},
163+
"completionEvents": [
164+
"onCommand:fastapi-vscode.searchEndpoints"
165+
]
166+
},
167+
{
168+
"id": "codelens",
169+
"title": "Navigate from Tests to Routes",
170+
"description": "CodeLens links appear above test client calls to jump directly to the route definition.",
171+
"media": {
172+
"image": "media/walkthrough/codelens.gif",
173+
"altText": "CodeLens link above test client call"
174+
}
175+
},
176+
{
177+
"id": "configure",
178+
"title": "Configure Your Project",
179+
"description": "If the extension doesn't find your FastAPI app automatically, you can specify the entry point in settings.\n[Open Settings](command:workbench.action.openSettings?[\"fastapi.entryPoint\"])",
180+
"media": {
181+
"image": "media/walkthrough/configure.gif",
182+
"altText": "FastAPI entry point configuration in VS Code settings"
183+
}
184+
},
185+
{
186+
"id": "feedback",
187+
"title": "Give Feedback & Get Help",
188+
"description": "Help us improve! Report bugs, request features, or contribute to the project.\n\n[Report an Issue](command:fastapi-vscode.reportIssue)\n[View on GitHub](https://github.com/fastapi/fastapi-vscode)",
189+
"media": {
190+
"image": "media/walkthrough/feedback.gif",
191+
"altText": "FastAPI extension output panel showing debug logs"
192+
}
193+
}
194+
]
195+
}
196+
],
129197
"configuration": {
130198
"title": "FastAPI",
131199
"properties": {

0 commit comments

Comments
 (0)