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

Standardize "Bevy" capitalization #1609

Open
BD103 opened this issue Aug 20, 2024 · 2 comments
Open

Standardize "Bevy" capitalization #1609

BD103 opened this issue Aug 20, 2024 · 2 comments
Labels
C-Content D-Trivial S-Ready-For-Implementation The core questions are answered: just add code

Comments

@BD103
Copy link
Member

BD103 commented Aug 20, 2024

I've been noticing a lot of inconsistency between capitalized "Bevy" and lowercase "bevy". We should decide on one and standardize it throughout our documentation (in a follow-up, ofc!).

Originally posted by @BD103 in #1605 (comment)

@BD103 BD103 added C-Content S-Needs-Design Needs some thought about how this could be solved D-Trivial labels Aug 20, 2024
@BD103
Copy link
Member Author

BD103 commented Aug 20, 2024

Pasting @TrialDragon's comments in here:

The difference is when we're referring to Bevy, the proper noun, and bevy, the name of the specific GitHub repository in which the engine lives. At least in this case.

Probable best way to deal with this is encapsulating all the repository references (e.g., bevy, bevy-website, etc.) in backticks ``, AKA single-line code blocks.

EDIT: This has, at least initially, been done in this PR. I may have missed stuff. Still a good idea to keep the follow-up issues open for standardizing the rest of the site if need be.

@alice-i-cecile
Copy link
Member

I agree with the style chosen by @TrialDragon there.

@alice-i-cecile alice-i-cecile added S-Ready-For-Implementation The core questions are answered: just add code and removed S-Needs-Design Needs some thought about how this could be solved labels Aug 23, 2024
@alice-i-cecile alice-i-cecile changed the title Standarize "Bevy" capitalization Standardize "Bevy" capitalization Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Content D-Trivial S-Ready-For-Implementation The core questions are answered: just add code
Projects
None yet
Development

No branches or pull requests

2 participants