Skip to content

Better layout docs and source #52

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 19 commits into from
Jun 13, 2025
Merged

Better layout docs and source #52

merged 19 commits into from
Jun 13, 2025

Conversation

thejpster
Copy link
Member

@thejpster thejpster commented Jun 3, 2025 •
edited
Loading

  • Re-works how we do keyboard layouts, using helper functions to simplify each layout.
  • Adds a nice diagram of each layout, and a tool to generate the diagrams
  • Control codes (like Ctrl+C => \U+0003) are now generated from the ASCII letter, avoiding mistakes like the last couple of PRs had to fix

@thejpster thejpster changed the title Draft: better layout docs Better layout docs and source Jun 5, 2025
@thejpster thejpster mentioned this pull request Jun 5, 2025
Closed
@thejpster thejpster added the draft label Jun 5, 2025
thejpster added 11 commits June 5, 2025 20:02
@thejpster
Move docs into lib.rs
0b6c451 
So it appears on docs.rs. Leave README for repo-level data.
@thejpster
Use Unicode literals
393e223 
Using Unicode Literals ('\u{0000}') is more consistent with the diagrams
I am about to add, and forces us to standardise on one notation instead
of a mixture of decimal and hexadecimal.
@thejpster
Add diagrams, and tool to generate them, plus helper functions.
5676c98
@thejpster
Clean up Azerty
329b71e
@thejpster
Print all keyboard types (except JIS)
9418a6b 
Now keyboard layouts know their own physical layout.
@thejpster
Update De105Key
f37e52d
@thejpster
Update Dvorak and Programmer's Dvorak
bb50357
@thejpster
Update FiSe105
f99aed8
@thejpster
Update No105
4a06354
@thejpster
Add missing diagrams.
02f9296 
Also clean up description text - we now longer show raw keys.
@thejpster
Rename handler functions.
4339cdf 
Also add one where the Alt key is the same regardless of shift status.
@thejpster thejpster removed the draft label Jun 6, 2025
@thejpster
Copy link
Member Author

OK, I'm done! This is ready to go.

eldruin
eldruin reviewed Jun 10, 2025
View reviewed changes
Copy link
Member

@eldruin eldruin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for all your work!
Do you think it would be worth noting this in the changelog?

@jonathanpallant
Copy link
Contributor

Ah, yes. I should do that.

@thejpster
Copy link
Member Author

OK, good to go

@thejpster thejpster mentioned this pull request Jun 12, 2025
Merged
@thejpster
Copy link
Member Author

Merged main with workflow updates

eldruin
eldruin approved these changes Jun 13, 2025
View reviewed changes
Copy link
Member

@eldruin eldruin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me, thank you!

@eldruin eldruin merged commit cfeb2ea into main Jun 13, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eldruin eldruin eldruin approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@thejpster @jonathanpallant @eldruin