godotengine / godot-docs

Godot Engine official documentation
https://docs.godotengine.org
Other
3.95k stars 3.22k forks source link

Standardize usage of compound words, and document standards in docs style guide #10218

Open tetrapod00 opened 1 week ago

tetrapod00 commented 1 week ago

Your Godot version: 4.4 Issue description: There are some compound words, like "antialiasing", that appear in the docs in both hyphenated form "anti-aliasing" and in single-word form "antialiasing". For consistent style, we should choose one form and standardize.

Some examples:

Resolved and standardized (within the manual):

This is a fairly low priority issue. We should not break translations just to change this. However, we should choose which form to use for each compound word, document that choice in the style guide, and change existing usages whenever other changes are being made.

There's also precedent in https://github.com/godotengine/godot-docs/pull/3502, https://github.com/godotengine/godot-docs/pull/6978 of applying changes like this all at once.

URL to the documentation page (if already existing): The whole manual and class reference.

Mickeon commented 5 days ago

Bit of a side note, we've broken translations for much less. I think going into a big pass for this is somewhat justified. I find consistency to be very important even for subtle details like these.

tetrapod00 commented 5 days ago

I've been doing the manual changes one word at a time in multiple individual PRs. When that's done (or at least once we have a comprehensive list of compound words), maybe we can collect them and do the class reference changes in a single big PR?

Mickeon commented 5 days ago

Sounds fine by me.