Standard Style for Docs

Arkinn

Further to the Current Efforts post:

I am thinking about a standard format for the documentation, we briefly went over some ideas for it, but these go into more detail, my current thoughts on this:

Bold text to highlight key words, or important notes in a sentence, also buttons, or links that need to be pressed.
Level 1 headings to be used for main title of a page
Level 2 headings to be used for chapters, or sectioning (to set apart different sections of content)
Level 3 headings to be used for titles of explanations, for example the labels on different parts of a form.
Alt Text brackets for images and animations:
{SS - Name} is to indicate a screenshot
{Anim - Name} is to indicate a animation/gif.
Code tags for file folders/names, and executable commands.

I would welcome any comments on the above, or anything you would like to add!

luceos

Arkinn could you please include an example, so we can actually see the visual difference? That would clarify this a lot I think, also for future collaborators.

jordanjay29

Don't forget about some of our existing style guidelines. Think about how we want to move forward, if we want to keep these, alter them or add more (most of yours above would be additions).