gamemanual0 / gm0

Game Manual 0 - The most extensive guide out there for FTC
https://gm0.org
Other
54 stars 92 forks source link

Update use of FIRST to be consistent across docs #415

Closed seakrueger closed 10 months ago

seakrueger commented 10 months ago

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 commented 10 months ago

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 commented 10 months ago

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 commented 10 months ago

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.

abidingabi commented 10 months ago

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 commented 10 months ago

Oops sorry, cannot read

abidingabi commented 10 months ago

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