Writing a guide is a super helpful way to contribute to the community; if there is something you struggled with and can document, your guide can help make the experience that much better for future learners.

Overview

Guides live on the upstream Threadbare repository, under Discussions. When submitting a guide, you'll start a new "discussion" in the Submissions category, where Threadbare maintainers can review it and comment on it to suggest edits. Once the guide is in good shape, a maintainer can transfer it to the Published category.

Starting a Discussion

Formatting

GitHub Discussions use Markdown for formatting; this is a standard way to represent **bold**, _italic_, [links](), and more in text. It's the same format used in GitHub Issues and across other platforms like Discord. You can use the formatting toolbar at the top of the text field, and you can paste or drag-and-drop images to embed them.

formatting toolbar

Be sure to preview your guide along the way to make sure it looks just how you want. If you need extra help formatting Markdown, be sure to read the GitHub Markdown guide.

Submitting

Once your guide (or its first draft) is finished, select Start discussion to submit it. A maintainer will review your submission, and may comment on it with feedback.

To edit your guide to address the feedback, use the ⋯ menu and select Edit, make your changes, then select Update discussion. Be sure to reply to the maintainer comment to let them know their feedback has been addressed.

Once the guide is approved, a maintainer will transfer it to the Published category.