Problem

Right now the example files are split up and across various sections of the repos. There is not a single "hello world" file our users can base their build off of.

At minimum, this will need a rules.mk a sample keyboard vial.json file of a basic 9 key plus encoder. It would be great to see a complex example too.

This should all be accessible from a sensible place, maybe in the docs repo, but maybe elsewhere in the project. Open to ideas here.

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?

Problem

Currently the guidance for pulling down the QMK fork and making use of it are not simple enough for new users.

Solution ideas

• This should be added to the https://vial-kb.github.io/gettingStarted/porting-to-vial.html page.
• Should probably include basic git pull info.
• Would be great to get a "this is where we're at" section to keep people updated on the status of the merge of Vial into QMK.

I had to add another udev rule for my vibl bootloader device, which enumerated a serial number of vibl:d4f8159c. The udev rules should at least mention this, if not include it in the main copy-paste script.

Now has this order

1 first-use
2 layers
3 macros
4 tap-dance
5 combos          <- duplicated
5 udev            <- duplicated
6 QMK settings 

https://github.com/vial-kb/vial-kb.github.io/blob/main/docs/manual/combos.md
https://github.com/vial-kb/vial-kb.github.io/blob/main/docs/manual/linux-udev.md

Rough plan for how we should restructure the first time use docs.

We have two main routes through the docs:

1. Keyboard user who wants to download and use Vial
2. Keyboard designer who wants to build support into their keyboard.

Notes on route 1 (keyboard user):

This is a limited use case for now as we're in pre release. This should be tackled with proper UI docs when the app has settled down.

Notes on route 2 (keyboard designer):

High level overview of flow:

1. Download Vial (for testing)
2. Clone vial-qmk
3. Build VIA support
4. Enable Vial in your rules file
5. Add a unique ID to your config.h
6. Optional: setup secure unlock combo
7. Build, test & repeat