Guide to the Guide Template

This is an example guide, using the guide_template.md template format

Guide Template: Main Title

This line could be a short description of the guide's intent, perhaps with a few pieces of key info. For example, explaining that the guides are written in markdown, and the content should be formatted for easy scanning.

Optional: If your guide is long and/or contains several sections, make a linked table of contents. When you change these links for your guide, note that the link and the name must match

• Heading Hierarchy
• Verbose Example
• Resources

Style suggestion: Two line breaks in the source before a new section makes it easier to scan when editing the raw markdown.

Use Semantic Markup

You can use bold text sparingly when you want to emphasize something more verbose than a heading

• The main title should be the only H1 (one hashtag in markdown)
• Subsequent headings should follow the heading hierarchy from H2 on down.
• Use markup to structure the information, not as visual formatting

Second Section

You might want a brief description of the key point at the top of a section to clarify its relevance

Sub-Section 1

• this heading uses H3
• keep it to the point
• make it easy to skim for what's important
• try to avoid padding language, yadda yadda

Sub-Section 2

• make sure this level of granularity is actually useful
• ...but if it is, go for it
• just keep it clear and easy to scan

This is a More Verbose Section

While guides will often rely on bullet points for easy scanning, you may need to explain something with fuller description. For example, a section like this might be helpful when you want to describe a concept or explain a trade-off between options.

If so, make judicious use of paragraph breaks, and try to keep your sentences clear and brief. Say as much as you need to say, but no more.

Resources

• This will usually be a bulleted link list
• This too would be a useful link
• You get the idea

This concludes the content of the guide. There's a standard footer below. Being standard, you'll want to keep that bit, but change the link accordingly.

---

End of Guide

To propose/submit changes, please edit the markdown file for this guide