How to Draft a Guide

Note: The guides team is currently updating the instructions on how to create a guide. We're asking everyone to pause working on a guide once they have finished gathering examples. For more information, see: Why Should I Stop After I've Gathered Examples for My Guide?

This page is a work in progress, please check back later for updated guidance.

Make sure your guide issue has the label 'Drafting a Guide'

Use the document, How to Format a Guide - WIP to format your guide. When completed, paste this text into a comment in your guide issue.

- [ ] completed How to Format a Guide - WIP

If you are adopting an unfinished guide, follow the instructions in How to Work on an Unfinished Guide. When completed, paste this text into a comment in your guide issue.

- [ ] completed How to Work on an Unfinished Guide

When you complete your draft, move the issue to the milestone, 'Peer Review'