chore: syntax cleanup and standardization #343
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
powercasgamer
suggested changes
Apr 6, 2024
olijeffers0n
requested changes
Apr 6, 2024
# Conflicts: # docs/paper/admin/reference/configuration/README.mdx
olijeffers0n
approved these changes
Apr 10, 2024
Leguan16
reviewed
Apr 11, 2024
zlataovce
commented
Apr 11, 2024
| @@ -95,6 +97,8 @@ To maintain consistency and readability across the documentation, please adhere | |||
|
|
|||
| 10. **Be Inclusive**: Be mindful of all readers and contributors. Use language that is inclusive and welcoming to everyone. | |||
|
|
|||
| 11. **Capitalise Vanilla**: When referring to the base game, use "Vanilla" with a capital "V". | |||
There was a problem hiding this comment.
should be capitalize as in the above diff (+ added to spell check 😄)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an attempt at standardizing some syntax and cleaning up capitalization + punctuation.
Top-level headings (#) should all now be
Upper Cased Like This, while other ones (##, ###, ...)Have only the first letter capitalized.Class, file, config key, ... references are now
encased in backticks.Some British English words were switched to their American counterparts and added to the spell checker.