diff --git a/docs/en/docs/editor-support.md b/docs/en/docs/editor-support.md index 6e8c307087..51feb542d5 100644 --- a/docs/en/docs/editor-support.md +++ b/docs/en/docs/editor-support.md @@ -1,12 +1,12 @@ # Editor Support { #editor-support } -The official [**FastAPI extension**](https://marketplace.visualstudio.com/items?itemName=FastAPILabs.fastapi-vscode) enhances your FastAPI development workflow with route discovery, navigation, as well as FastAPI Cloud deployment, and live log streaming. +The official FastAPI Extension enhances your FastAPI development workflow with *path operation* discovery, navigation, as well as FastAPI Cloud deployment, and live log streaming. -For more details about the extension, refer to the README on the [GitHub repository](https://github.com/fastapi/fastapi-vscode). +For more details about the extension, refer to the README on the GitHub repository. ## Setup and Installation { #setup-and-installation } -The FastAPI extension is available for both [VS Code](https://code.visualstudio.com/) and [Cursor](https://www.cursor.com/). It can be installed directly from the Extensions panel in each editor by searching for "FastAPI" and selecting the extension published by FastAPI Labs. The extension also works in browser-based editors such as [vscode.dev](https://vscode.dev) and [github.dev](https://github.dev). +The **FastAPI Extension** is available for both VS Code and Cursor. It can be installed directly from the Extensions panel in each editor by searching for "FastAPI" and selecting the extension published by **FastAPI Labs**. The extension also works in browser-based editors such as vscode.dev and github.dev. ### Application Discovery { #application-discovery } @@ -14,10 +14,10 @@ By default, the extension will automatically discover FastAPI applications in yo ## Features { #features } -- **Path Operation Explorer** — A sidebar tree view of all routes in your application; click to jump to any route or router definition. -- **Route Search** — Search routes by path, method, or name with `Ctrl+Shift+E` (`Cmd+Shift+E` on Mac). -- **CodeLens Navigation** — Clickable links above test client calls (e.g. `client.get('/items')`) that jump to the matching route for quick navigation between tests and implementation. -- **Deploy to FastAPI Cloud** — One-click deployment of your app to FastAPI Cloud. -- **Stream Application Logs** — Real-time log streaming from your FastAPI Cloud-deployed application with level filtering and text search. +- **Path Operation Explorer** - A sidebar tree view of all *path operations* in your application. Click to jump to any route or router definition. +- **Route Search** - Search by path, method, or name with Ctrl + Shift + E (on macOS: Cmd + Shift + E). +- **CodeLens Navigation** - Clickable links above test client calls (e.g. `client.get('/items')`) that jump to the matching *path operation* for quick navigation between tests and implementation. +- **Deploy to FastAPI Cloud** - One-click deployment of your app to FastAPI Cloud. +- **Stream Application Logs** - Real-time log streaming from your FastAPI Cloud-deployed application with level filtering and text search. -If you'd like to familiarize yourself with the extension's features, you can checkout the extension walkthrough by opening the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and selecting "Welcome: Open walkthrough..." and then choosing the "Get started with FastAPI" walkthrough. +If you'd like to familiarize yourself with the extension's features, you can checkout the extension walkthrough by opening the Command Palette (Ctrl + Shift + P or on macOS: Cmd + Shift + P) and selecting "Welcome: Open walkthrough..." and then choosing the "Get started with FastAPI" walkthrough. diff --git a/docs/en/docs/tutorial/index.md b/docs/en/docs/tutorial/index.md index b2ce3f69fc..acd1a2d017 100644 --- a/docs/en/docs/tutorial/index.md +++ b/docs/en/docs/tutorial/index.md @@ -86,11 +86,10 @@ If you want to install the standard dependencies but without the `fastapi-cloud- /// tip -FastAPI has an official extension for VS Code, which provides a lot of features, including a path operation explorer, path operation search, CodeLens navigation in tests, and FastAPI Cloud deployment and logs — all from your editor. +FastAPI has an official extension for VS Code (and Cursor), which provides a lot of features, including a path operation explorer, path operation search, CodeLens navigation in tests (jump to definition from tests), and FastAPI Cloud deployment and logs, all from your editor. /// - ## Advanced User Guide { #advanced-user-guide } There is also an **Advanced User Guide** that you can read later after this **Tutorial - User guide**.