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.

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

merged 2 commits into from
Jul 9, 2024

Conversation

atsansone
Copy link
Contributor

Fixes #4057

@dart-github-bot
Copy link
Collaborator

dart-github-bot commented Jul 1, 2024

Visit the preview URL for this PR (updated for commit 9cadd8d):

https://dart-dev--pr5958-fix-4057-l8uoj4d3.web.app

Comment on lines 13 to 14
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

Comment on lines 45 to 48
## 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)

consult its [documentation][].

[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

Comment on lines 45 to 48
## 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.

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

Comment on lines 30 to 31
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.

consult its [documentation][].

[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.

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

@atsansone atsansone assigned atsansone and unassigned MaryaBelanger Jul 9, 2024
@atsansone atsansone merged commit cf816dd into dart-lang:main Jul 9, 2024
10 checks passed
atsansone added a commit to atsansone/site-www that referenced this pull request Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Expand Visual Studio Code documentation
3 participants