-
-
Notifications
You must be signed in to change notification settings - Fork 422
[skip changelog] Make "Getting started" page more friendly to new users of Arduino CLI #782
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@per1234 do we have another place in our docs where the usage of --additional-urls is described in addition to this one that you are removing?
IIRC we wrote this paragraph because users got confused by this option. I'm ok regarding this PR, but I would like to keep info regarding this option in a more suited place of the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The only other place it's described is on every page of the command reference (e,.g., https://arduino.github.io/arduino-cli/dev/commands/arduino-cli/#options), which doesn't give much information on it. I don't see another place in the documentation where this information would fit.
I'm fine with leaving it in the Getting Started page. I explained my reasoning in the commit message, but I don't have super strong feelings about this subject.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The FAQ Page maybe could be a good place to move this whole paragraph, for example in a "how the --additional-urls option works?"
WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've given it some thought and I just don't think it's a good fit for the FAQ page.
What I suggest is that I abandon my proposal to remove the --additional-urls information from the Getting Started page (making this PR solely about the "Clarify wording of upload instructions in Getting Started page" proposal).
I can perhaps revisit the idea of moving the --additional-urls information from the Getting Started page if we someday add another page to the documentation that is appropriate for it (something like a "Going further" page).
Please check if the PR fulfills these requirements
Docs update
The Getting started page contains some content that is unclear or unnecesarily detailed for the target audience.
The getting started page is more friendly to people getting started with using Arduino CLI.
No.