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

Mention requirement for compatible firmware #23

Open
okin opened this issue Jul 8, 2022 · 0 comments
Open

Mention requirement for compatible firmware #23

okin opened this issue Jul 8, 2022 · 0 comments

Comments

@okin
Copy link
Contributor

okin commented Jul 8, 2022

While it is obvious to probably most veteran users Vial does require a board to have a Vial-compatible firmware installed.
I believe this should be mentioned in the docs in a prominent place.

Not sure where to put this is the best place. Front page or the First time use come to mind as this is probably where users start to look first.
I'd say front page is good because this is what most people see but since this is already mostly text it might be overlooked there. First time use might be a better candidate but then we probably should introduce a section like Preparing your keyboard or something along the lines.

For many probably the next questions are:

  • is my board compatible?
  • where do I find a firmware?
  • how do I get it onto my board?

I think these should also be adressed in order to help new users understand the required steps. Maybe we could add another page specific to this questions.

What do you think?

ideas32 added a commit to ideas32/vial-kb.github.io that referenced this issue Dec 7, 2022
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

No branches or pull requests

1 participant