vial-kb.github.io's People
Forkers
winslet erkhal jkutianski oakninja stefanrua kaz3304 jackpikatea specialbomb okin nisker thompson-vii tweetydabird szzze archcorsair ideas32 adophoxia xisang233 sporkus jeffdhootonvial-kb.github.io's Issues
To do: Restructure getting started
Rough plan for how we should restructure the first time use docs.
We have two main routes through the docs:
- Keyboard user who wants to download and use Vial
- 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:
- Download Vial (for testing)
- Clone
vial-qmk
- Build VIA support
- Enable Vial in your
rules
file - Add a unique ID to your
config.h
- Optional: setup secure unlock combo
- Build, test & repeat
Duplicated order on pages udev & combos
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
Linux udev rules should include one for vibl bootloader devices
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.
To do: Write temporary docs for using QMK fork
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.
To do: Example Vial config files
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.
Mention requirement for compatible firmware
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?
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.