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

api template #169

Open rulalub opened 3 years ago

rulalub commented 3 years ago

Template description

Describe the template you think our project should provide

Benefits

Describe the advantages that this template would have

Use cases

Describe some scenarios in which this template might be useful

Additional information

Provide any additional requirements, context, or links that might be helpful

AstroChoco commented 3 years ago

@camerons shall I take this task? Will the file format be Markdown?

camerons commented 3 years ago

@AstroChoco, I think that @aidanatwork is planning to look into templates, so I suggest only taking this on if @aidanatwork is not. Our thinking is currently moving forward with regards to what should be in a template, and I'm currently updating our base template, which defines what all our other templates will require. I expect to be draft ready in Feb/Mar 2021 timeframe, and I suggest postponing creating any new templates until then. Draft is being developed on this branch. Yes, format will be Markdown.

AstroChoco commented 3 years ago

@AstroChoco, I think that @aidanatwork is planning to look into templates, so I suggest only taking this on if @aidanatwork is not. Our thinking is currently moving forward with regards to what should be in a template, and I'm currently updating our base template, which defines what all our other templates will require. I expect to be draft ready in Feb/Mar 2021 timeframe, and I suggest postponing creating any new templates until then. Draft is being developed on this branch. Yes, format will be Markdown.

Thanks for the info, @camerons . I will check what I can do around the end of March.