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

Update use of FIRST to be consistent across docs #415

Merged
merged 14 commits into from
Nov 18, 2023

Conversation

seakrueger
Copy link
Contributor

@seakrueger seakrueger commented Nov 15, 2023

I noticed that the use of FIRST was not consistent across the site, so I updated them to be. Now, the first instance of FIRST in either a heading or on the page includes the registered trademark symbol and all subsequent instances consist of just the name capitalized and italicized. Used this PDF from the branding section on First's website.

@abidingabi
Copy link
Member

Thank you! We should probably apply the same treatment to FRC and FTC in regards to the trademark symbol (though not the italicization, see https://docs.wpilib.org/en/stable/docs/contributing/frc-docs/style-guide.html#text).

@seakrueger
Copy link
Contributor Author

seakrueger commented Nov 15, 2023

Got it. Do you still want me to revert the registered symbol on the first instance only change? I did notice that the \ |reg| on all FIRST instances style was a lot more consistent across the older pages...

@abidingabi
Copy link
Member

No, I was wrong about that :). The symbol should be only on the first usage according to FIRST’s styleguide.

It used to be on every instance because for a while we used ohnoyoudidnt which enforced that, but we stopped using it at some point (as did FRC docs), as it has some issues and is unmaintained.

@seakrueger seakrueger marked this pull request as ready for review November 15, 2023 22:11
@abidingabi
Copy link
Member

In regards to text in bold, note that the FRC docs style guide explicitly states that in that situation you do not have to format the trademark:

Specifically, where possible (i.e. not nested inside other markup or in a document title), the first use of the trademarks should have the ® symbol and all instances of FIRST should be italicized

I think that’s a reasonable thing to follow here as well. Stylistically, I would rather have the whole statement bolded as opposed to having the one word unbolded just for the trademark symbol.

@seakrueger
Copy link
Contributor Author

Oops sorry, cannot read

@abidingabi
Copy link
Member

Heads up, italics don’t work inside of link text, see e.g. https://game-manual-zero--415.org.readthedocs.build/en/415/docs/useful-resources.html#general-resources.
image

@abidingabi abidingabi merged commit d482a9a into gamemanual0:main Nov 18, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants