To make sure we have consistent format, here are the guidelines we have tried to keep for writing Sponge Documentation.
- Headings Should Be Written in Title Case (<- example)
- Page headings should be meaningful (the heading appears as a link)
- Program code is contained in quotes or code blocks
i. Try not to put too much text in - code blocks are not translated
- Separate areas for Users, Plugin Devs, and Sponge Devs
- Avoid repetition by sharing pages where possible
- Link to external resources rather than reproduce them
i. Some exceptions are made for translation purposes
- Make distinction between Sponge (coremod), SpongeVanilla and Sponge API
- If it looks awful in your language, invent your own rules
Sponge is the project Title and preferably should NOT be translated.
i. Some languages may wish to use a phonetic translation as well
- Automated translations (eg. Google Translate) are strongly discouraged. These often contain serious errors, and are very likely to be rejected
- Page Titles and Headings should use plain text, avoiding
literalblocks and other formatting.
- References to class names should have no extra spaces (eg. blockstate, not block state) and be formatted as a literal (eg. ``class``)
- Lines should have a maximum length of 120 characters.
- Imports should be written out in code blocks the first time they are referenced in each article, but not repeated after the first time.
This list may get added to (or bent out of shape) as the Docs get bigger, and is reproduced in Contributing to Spongedocs
I hope this helps our Contributors and Translators.
Contributions, suggestions and corrections are always welcome.