Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update VS Code page #5958

Merged
merged 2 commits into from
Jul 9, 2024
Merged

Update VS Code page #5958

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebf6d43
Update VS Code page
Jul 1, 2024
9cadd8d
Update vs-code.md per @MaryaBelanger review
atsansone Jul 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 42 additions & 12 deletions src/content/tools/vs-code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,49 @@ description: You can use VS Code to develop Dart apps.
toc: false
---

With the Dart plugin, you can use [Visual Studio Code (VS Code)][vs-code]
to develop Dart apps.
The Flutter site has details on how to set up and use VS Code for Flutter apps.
To develop Dart apps,
install [Visual Studio Code][vs-code] (VS Code)
and add the [Dart extension][].

Until this page has more information,
see the Flutter documentation for instructions that you can apply to
other kinds of Dart apps:
## Install VS Code

* [Set up an editor][setup] on the Flutter site has
instructions for installing the Flutter and Dart plugins into VS Code.
* [Visual Studio Code][vscode-flutter] on the Flutter site has
details on using VS Code to develop Flutter apps.
To build and debug apps,
you can use the [VS Code][] integrated development environment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence seems unnecessary, repeats lines 7-9


[setup]: {{site.flutter-docs}}/get-started/editor?tab=vscode
To install the latest version of VS Code,
follow Microsoft's instructions for the relevant platform:

- [Install on macOS][]
- [Install on Windows][]
- [Install on Linux][]

[VS Code]: https://code.visualstudio.com/
[Install on macOS]: https://code.visualstudio.com/docs/setup/mac
[Install on Windows]: https://code.visualstudio.com/docs/setup/windows
[Install on Linux]: https://code.visualstudio.com/docs/setup/linux

## Install the VS Code Dart extension

With the Dart extension installed,
you can compile, deploy, and debug Dart apps.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, seems like another unnecessary repetition of the intro sentence lines 7-9. Instead I'd start this section something like:

Suggested change
With the Dart extension installed,
you can compile, deploy, and debug Dart apps.
The Dart extension for VS Code enables support for
Dart and Flutter specific development,
like syntax highlighting, package resolution, hot reload, and more.
For the full list of features,
see the [extension documentation][Dart extension]

Also, you rewrote the original lines 7-9 that started with "With the Dart plugin...", but then used that same structure here ("With the Dart extension..."). Is starting a sentence like that something that needs to be rewritten or not?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eh, it could go either way.


1. Launch **VS Code**.

1. Click **Extensions** in the **Activity Bar**.
You can also press
<kbd>Control</kbd> / <kbd>Command</kbd> +
<kbd>Shift</kbd> + <kbd>X</kbd>.

1. In the Search box, type `Dart`.
The first extension returned should be the [Dart extension][].

1. Click **Install**.

## Dart Extension documentation

To learn more about the features of the VS Code Dart extension,
consult its [documentation][].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd remove this section in favor of just linking to the documentation in the intro of the previous section (the way I rewrote it)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of this section, why not point to the Flutter VS Code docs:

Suggested change
## Dart Extension documentation
To learn more about the features of the VS Code Dart extension,
consult its [documentation][].
## Flutter VS Code documentation
The Flutter documentation contains more in-depth, Flutter-specific
VS Code content on [setting up an editor][] and [using VS Code][]
to develop Flutter apps.
[setting up an editor]: {{site.flutter-docs}}/get-started/editor?tab=vscode
[using VS Code]: {{site.flutter-docs}}/tools/vs-code


[Dart extension]: https://marketplace.visualstudio.com/items?itemName=Dart-Code.dart-code
[documentation]: https://dartcode.org/docs/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the Marketplace link is better because it lists all the pertinent information upfront. It also links to this page, so I think linking only to the Marketplace page is sufficient.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like you can remove this since you're not using it anymore

[vs-code]: https://code.visualstudio.com/
[vscode-flutter]: {{site.flutter-docs}}/development/tools/vs-code