search

thegooddocsproject / templates

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

Create API-reference template #213

Open aidanatwork opened 3 years ago

aidanatwork commented 3 years ago

Create API-reference template

Description

Doc Type Name: API-reference

Directory: https://github.com/thegooddocsproject/templates/tree/dev/api-reference

Sub-tasks

  1. Create api-reference-template.md and write content for it
  2. Create api-reference-guide.md and write content for it
camerons commented 2 years ago

We currently have both an reference/ template and an api-reference template.

For a March 2022 release, we should either bring the api-reference template to align with https://github.com/thegooddocsproject/templates/blob/dev/CONTRIBUTING.md, or move it outside of the deliverabe.

This might involve moving onto a separate branch, and deprecating on the main branch.