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

Strip QMK and Userspace keyboard readme's #24

Open
2 of 5 tasks
bstiq opened this issue Aug 4, 2024 · 4 comments
Open
2 of 5 tasks

Strip QMK and Userspace keyboard readme's #24

bstiq opened this issue Aug 4, 2024 · 4 comments

Comments

@bstiq
Copy link
Member

bstiq commented Aug 4, 2024

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
  • update the charybdis docs
  • update the dilemma docs
@bstiq
Copy link
Member Author

bstiq commented Aug 18, 2024

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

@bstiq
Copy link
Member Author

bstiq commented Aug 21, 2024

PR in progress to move the charybdis features to the docs here: #27

@bstiq
Copy link
Member Author

bstiq commented Aug 21, 2024

Charybdis PR merged.
Dilemma PR in progress: #28

@bstiq
Copy link
Member Author

bstiq commented Aug 22, 2024

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.

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