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

Expanding the Glossary #2443

Merged
merged 8 commits into from
Dec 28, 2023
Merged

Conversation

jasondaming
Copy link
Member

Based on numerous CD threads there are a lot of acronyms used. Wanted to expand this glossary to include them.

Thoughts on abbreviation structure? We could instead list the term and then include the abbreviation in the description.

Do you think all of this should go into the glossary? I have heard arguments about breaking it up. To me a glossary is not really something you read it is instead something that is searched for to answer a specific need. In this case the size is irrelevant but the completion only becomes more helpful with more entries.

@jasondaming jasondaming marked this pull request as draft December 16, 2023 18:55
@jasondaming
Copy link
Member Author

@Kevin-OConnor I did make a few changes to ZTR figured I should tag you but it is really just correcting an abbreviation that was wrong. PH->PDH

@sciencewhiz
Copy link
Collaborator

Seems like a good place to fix #2388

@sciencewhiz
Copy link
Collaborator

I like all the entries except EPA and OPR. Those seem to be getting too far away from the purpose of frc-docs

@jasondaming
Copy link
Member Author

Fixes #2388

I think EPA and OPR are used often enough in the FRC context to warrant inclusion. I am not going to die on this hill however so am interested in what others think.

@jasondaming jasondaming marked this pull request as ready for review December 22, 2023 13:36
@sciencewhiz sciencewhiz linked an issue Dec 22, 2023 that may be closed by this pull request
@sciencewhiz sciencewhiz merged commit 23b35cd into wpilibsuite:main Dec 28, 2023
10 checks passed
@jasondaming jasondaming deleted the glossaryabb branch December 28, 2023 04:49
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.

Add "no-op" to glossary
2 participants