Skip to content

Improve Documentation #2497

@bsutton

Description

@bsutton

I wanted to give some feedback on my time using dart-code in vscode and particularly the startup experience.

So firstly great tool and I largely enjoy my time working with vscode and dart-tools.

So now the complaint :)

I came to dart-tools as a first time vscode user (long time eclipse user) and as such had no idea how either worked.

I would speculate that my startup experience is not an uncommon one.

The problem is that (and this is a problem with most vscode extensions) they expect you to know how to use vscode.

Of particular note is settings.
When I first started I hand no idea about the .vscode directory nor the launch.json or settings.json.

Much of the extension code says things like place 'fred.impoort.x=y' in your settings file.

Where is my settings file?
Once I found the settings file exactly where does it go in the settings file?

These type of assumptions make it quite hard to get up and running.

The other issues is the lack of documentation on the available settings.
Through my discussions with you I've discovered a number of useful settings.
It would be much better if there was a documented that described each setting and where to place them.
There also needs to be doco on the lauch.json configuration and flutter specific options.

Some of the issues that have been hard to find.

How to pass args to a launch.
How to use the 'console' option.

In another issue we have discussed the new --fast-start option.
Given the importance of this feature there should be doco on how to use it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    in docs / websiteRelates to documentation, including the Dart Code website

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions