Strip QMK and Userspace keyboard readme's

bstiq commented 1 month ago

Topic of discussion re:our qmk userspace:

currently the info about each specific keyboard + pictures of its keymaps are in:

the readme of the keyboard in our QMK userspace
the readme of the keyboard in the main QMK repository
scattered in various parts of the docs - in bkb keymaps and charybdis firmware

and those 3 are essentially duplicates, so harder to manage and harder to find info.

upstream QMK readmes can be stripped - most of the stuff there never seemed to help anyone who couldn't already navigate the folder structure and read the code itself to begin with

TODO:

[ ] strip the readme of the keyboard in our QMK userspace
[ ] strip the readme of the keyboard in our QMK repository
[ ] push changes to the main QMK repo
[x] update the charybdis docs
[x] update the dilemma docs

bstiq commented 4 weeks ago

Initial version for review here: https://bstiq.github.io/bstiqbstkbd.github.io/fw/charybdis-features.html

bstiq commented 3 weeks ago

PR in progress to move the charybdis features to the docs here: https://github.com/Bastardkb/bastardkb.github.io/pull/27

bstiq commented 3 weeks ago

Charybdis PR merged. Dilemma PR in progress: https://github.com/Bastardkb/bastardkb.github.io/pull/28

bstiq commented 3 weeks ago

Dilemma PR merged. Next step will be to clear up the QMK readme's. It's not clear right how low of a level of detail the QMK team will accept in the readme's. It seems linking to external docs is not the recommended way. On top of this, we are having trouble upstreaming changes (a lot of trouble). Maintaining our own separate QMK fork is also an option.

Bastardkb / bastardkb.github.io

Strip QMK and Userspace keyboard readme's #24