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

docs: glossary for keyboard author #1827

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Meng-Heng
Copy link
Collaborator

@Meng-Heng Meng-Heng commented Jan 28, 2025

Fix: Build a glossary page for keyboard authors (developer/language/guide?) (link to Google Sheet)

I put together a glossary page with a few new glossaries but the others are from Keyman Glossary

@mcdurdin, @darcywong00, @LornaSIL, could I ask for your input on what else to add?


Questions and Request:

  1. Is developer/language/guide a suitable location for this?
  2. Appearance preferences?
  • image
  • image
  1. Please help add more to the content.

Thank you!

@Meng-Heng Meng-Heng marked this pull request as draft January 28, 2025 09:30
@Meng-Heng Meng-Heng marked this pull request as draft January 28, 2025 09:30
@Meng-Heng Meng-Heng marked this pull request as ready for review January 29, 2025 06:19
@LornaSIL
Copy link
Contributor

I would like us to define "package" and then maybe start using the word "bundle" for when we put 2 or more keyboards together into one distribution.

Then, I'd like the packages folder to be renamed bundles (there are no packages folders in experimental or legacy. What do you think @mcdurdin ?

@darcywong00 darcywong00 added this to the B18S1 milestone Feb 1, 2025
@mcdurdin
Copy link
Member

mcdurdin commented Feb 2, 2025

Then, I'd like the packages folder to be renamed bundles (there are no packages folders in experimental or legacy. What do you think @mcdurdin ?

I think this needs to be a separate discussion. The term 'bundle' or 'bundling' was used in the past for bundling Keyman together with keyboard packages, so I am hesitant to overload the term now. But a change like this needs to be in a separate issue on the keyboards repo if we want to explore it.

For this PR, it'd be good to define existing terminology as clearly as possible, without changes. We can iterate on changes once we clarify how we already use terminology.

@mcdurdin
Copy link
Member

mcdurdin commented Feb 2, 2025

I still need to review the terms in the list; I think there are quite a few we still need to define, and some of the definitions probably need a bit of input from me and others on the team.

@ermshiperete
Copy link
Contributor

As for the appearance, I like the first option better. I think it makes it easier to see the terms if they show up as headings, plus I like it to see the terms in the index as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

5 participants