Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Create API-reference template #213

Open
aidanatwork opened this issue Aug 25, 2021 · 1 comment · May be fixed by #252
Open

Create API-reference template #213

aidanatwork opened this issue Aug 25, 2021 · 1 comment · May be fixed by #252
Labels
templates Denotes only issues about creating our doc type templates. templates-p3

Comments

@aidanatwork
Copy link
Contributor

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
@aidanatwork aidanatwork added templates Denotes only issues about creating our doc type templates. templates-p3 labels Aug 25, 2021
@aidanatwork aidanatwork self-assigned this Aug 25, 2021
@camerons
Copy link
Member

camerons commented Dec 7, 2021

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.

@tang-mm tang-mm linked a pull request Jun 27, 2022 that will close this issue
Open
44 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
templates Denotes only issues about creating our doc type templates. templates-p3
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add API reference template and guide tang-mm/templates
2 participants
@camerons @aidanatwork