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

keymap images #12

Merged
merged 17 commits into from
Apr 1, 2024
Merged

keymap images #12

merged 17 commits into from
Apr 1, 2024

Conversation

burkfers
Copy link
Collaborator

@burkfers burkfers commented Mar 15, 2024

todo:

  • make drawing all boards in a pretty manner possible
  • Charybdises: Verify the layouts drawn are the stock via layouts
    • Nano
    • Mini
    • Full size
  • Dactyls: Add the stock layouts in yaml
    • Skeleyl
    • TBK Mini
    • Scylla
  • write a page that includes the images

@burkfers
Copy link
Collaborator Author

Companion PR for keymap-drawer support in flight: caksoylar/keymap-drawer#76

@bstiq
Copy link
Member

bstiq commented Mar 18, 2024

Once the keymap pictures are final, we should also:

  • update the online docs to link to them (in the final steps)
  • upload the keymap pictures to the product pages on the website (to be discussed internally)
  • link to them on the main readme.md page of each repository

burkfers added 2 commits March 21, 2024 17:01
Unfortunately cspell does not care about code blocks in markdown.
Have to add some literals to the wordlist
@burkfers
Copy link
Collaborator Author

All done!

When reviewing, please pay special attention to the layer names of the dactyls. As all three only use numbered indices in the source and a single number as the layer name doesn't look very appealing in the image, I made up some names.

I excluded using the new images on any pages from this PR as the customizing section need other work as well, which would bloat the scope of this PR.

@burkfers burkfers marked this pull request as ready for review March 21, 2024 16:15
@bstiq bstiq mentioned this pull request Mar 31, 2024
5 tasks
@bstiq
Copy link
Member

bstiq commented Mar 31, 2024

Good to go on my side. From my initial review of the images the layouts seem fine, if there's a few small mistakes they can be corrected later.

As discussed on Discord by @finrod09 :

Leaving the images in the docs and linking there from outside makes the most sense to me, since the source to generate them lives there as well.

This also makes it simpler to update the images if/when needed (eg. the ongoing conversation about the placement of reset keycodes).

Now that those pictures are generated, we should include them somewhere in the docs. I opened a separate issue #17

@bstiq bstiq merged commit 19534cc into Bastardkb:master Apr 1, 2024
1 check passed
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

Successfully merging this pull request may close these issues.

2 participants