Skip to content

DOCS: FAQ should answer questions, not just give more info #1236

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

Open
PeterNerlich opened this issue Mar 25, 2021 · 0 comments
Open

DOCS: FAQ should answer questions, not just give more info #1236

PeterNerlich opened this issue Mar 25, 2021 · 0 comments
Assignees
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement

Comments

@PeterNerlich
Copy link

Docs request

This concerns docs/FAQ.md.

Current behavior

"Arduino Nano/Uno/Mega is not detected" explains the context why this situation might occur.

Expected behavior

"[What to do when] Arduino Nano/Uno/Mega is not detected?" should not only explain where this situation might stem from, but give directions what to do in order to still work with the device.

I imagine this would probably be

  • how to figure out what exact model you have and what FQBN string that corresponds to
  • how to use the device while explicitly telling arduino-cli what FQBN it is

Additional notes

If I were to be even more nitpicky, "Additional assistance" should probably be "Where to get additional assistance".

@per1234 per1234 added topic: documentation Related to documentation for the project type: enhancement Proposed improvement labels Mar 25, 2021
@per1234 per1234 self-assigned this Nov 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

2 participants