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

Chronologue docs: How Chronologue API works #10

Open
11 tasks
kickoke opened this issue Jun 8, 2022 · 0 comments · May be fixed by #22
Open
11 tasks

Chronologue docs: How Chronologue API works #10

kickoke opened this issue Jun 8, 2022 · 0 comments · May be fixed by #22
Assignees
@valeriahhdez
Labels
documentation Improvements or additions to documentation

Comments

@kickoke
Copy link
Collaborator

kickoke commented Jun 8, 2022 •
edited by valeriahhdez
Loading

Summary

"How Chronologue API works" is a Concept that provides Scientists and Developers with an overview of the API architecture on a higher level.

Research

  • Determine user goals.
  • Determine prerequisites
  • Determine what steps the user has to take.

Writing/Testing

  • Create a new branch.
  • Create a draft.
  • Write a commentary in the document to highlight best practices.
  • Take feedback notes for the template group.
  • Create a PR.

Review

  • Grammatical review.
  • Technical review.

Publication

  • Merge PR to docs.

Resources

Source file: API overview
Template: Overview
Feedback form: INSERT LINK
@kickoke kickoke added the documentation Improvements or additions to documentation label Jun 8, 2022
@valeriahhdez valeriahhdez linked a pull request Jul 22, 2022 that will close this issue
Create API_overview.md #22
Open
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@valeriahhdez valeriahhdez

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Create API_overview.md thegooddocsproject/chronologue
2 participants
@kickoke @valeriahhdez