Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 1.73 KB

example-guide.md

File metadata and controls

59 lines (41 loc) · 1.73 KB

Guide Title (Only Visible in GitHub)

December 13, 2023

This is a guide on how to make Coder guides, it is not listed on our official tutorials page in the docs. Intended for those who don't frequently contribute documentation changes to the coder/coder repository.

Content

Defer to our documentation style guide page for rules on technical writing.

Add photos

Use relative imports in the markdown and store photos in docs/images/guides/<your_guide>/<image>.png.

Set the author data

At the top of this example you will find a small html snippet that nicely renders the author's name and photo, while linking to their GitHub profile. Before submitting your guide in a PR, replace your_github_handle, your_github_profile_photo_url and "Your Name". The entire <img> element can be omitted.

Set up the routes

Once you've written your guide, you'll need to add its route to docs/manifest/tutorials.yml under children:

# The title overrides the "# Guide Title" at the top of this file.
- title: Contributing to Guides
  description: How to add a guide
  path: ./tutorials/my-guide-file.md

Then run make gen/docs-manifest to format the sidebar sources and rebuild docs/manifest.json.

Format before push

Before pushing your guide to github, run make fmt to format the files with Prettier. Then, push your changes to a new branch and create a PR.