thegooddocsproject / templates

Templates created by The Good Docs Project - for all your tech writing needs.
https://thegooddocsproject.dev/
Other
680 stars 170 forks source link

Quickstart template #232

Closed gayathri-krishnaswamy closed 2 years ago

gayathri-krishnaswamy commented 3 years ago

Hi All,

Chris, Nelson, and I worked on creating this quickstart template and the "about" guide under the guidance of Cameron. We used Deanna's tutorial as our base and made changes to suit a quickstart. We are finally ready to raise this PR. :smiley:

Looking forward to hearing all your feedback/suggestions/comments.

Template quality checklist

This quality checklist will eventually become a pull request template that every contributor needs to add to pull requests against the templates repository.

Pull request summary

{Describe the purpose of your pull request.}

{Also indicate which template working group you belong to and who your template mentor is.}

Template contributor checklist

IMPORTANT: The next three sections in this checklist should be filled out by the template contributor at the time they submit this request.

NOTE: Pull requests can only be merged when all boxes are checked.

Which issue does this pull request fix or reference?

This pull request:

Procedural requirements

Template set requirements

Template pull request reviewer checklist

IMPORTANT: The rest of the sections in this checklist should only be filled out by authorized Good Docs Project pull request reviewers. If you are the individual template contributor, do not fill out the rest of the fields or check the boxes.

NOTE: Pull requests can only be merged when all boxes are checked.

Mechanics and formatting requirements - PULL REQUEST REVIEWER ONLY

Overall usability - PULL REQUEST REVIEWER ONLY

Template file requirements - PULL REQUEST REVIEWER ONLY

Template guide requirements - PULL REQUEST REVIEWER ONLY

Deep dive requirements (optional) - PULL REQUEST REVIEWER ONLY

Template example requirements (optional) - PULL REQUEST REVIEWER ONLY