search

flutter / website

Flutter documentation web site
https://docs.flutter.dev
Other
2.83k stars 3.23k forks source link

Don't show Flutter doctor output in install docs #10885

Open johnpryan opened 4 months ago

johnpryan commented 4 months ago

Our install docs take a guess at what the user's flutter doctor output should look like, but this is unnecessary and could be simplified to just recommending runnning flutter doctor. It's also hard to maintain so many copies of flutter doctor output in our docs

Screenshot 2024-07-11 at 4 09 03 PM

In our docs code, there are multiple conditionals that need to be maintained to display this properly: https://github.com/flutter/website/blob/e63f3ef9c0d395bb5cdbd774820a406c211a1705/src/_includes/docs/install/flutter-doctor-success.md#L4

This is not a great strategy for our docs to maintain a file like this, I would prefer we take it out and just tell the user to run flutter doctor.

sfshaza2 commented 4 months ago

That makes a lot of sense.

atsansone commented 4 months ago

@johnpryan : As these docs are written for new users, we have tried to show the results of all commands. This was done with some work, but works well now and eliminates any possible confusion as to what should be seen. The maintenance is minimal, as this should rarely, if ever change. Closing for now.

johnpryan commented 4 months ago

I would prefer to leave this issue open to discuss this more, what happens when the output of flutter doctor changes? Why is it important to maintain a set of includes that for example, remove XCode from the list when they select a platform that doesn't support it? There's a significant maintenance cost here and I feel that closing this issue isn't the best way forward.