Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Documentation to Duck Endpoint #69

Open
1 of 2 tasks
William-McGonagle opened this issue Dec 29, 2021 · 2 comments
Open
1 of 2 tasks

Add Documentation to Duck Endpoint #69

William-McGonagle opened this issue Dec 29, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@William-McGonagle
Copy link
Member

William-McGonagle commented Dec 29, 2021

Idea

Our duck generator system is one of the best parts of our codebase. But, we've reached a bit of a problem. We need to document what is going on and how to use it. You can learn more about how to use it in some of our old closed issues- I can link some of them below.

If you want to help with this, drop us a comment and we will assign the issue to you. Cheers!

Todo

  • Add to the OpenAPI file information about how to query the endpoints
  • Write a bit in the documentation about what the endpoints do and how to use them
@William-McGonagle William-McGonagle added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Dec 29, 2021
@William-McGonagle
Copy link
Member Author

You can check out the duck generator here, and the code for it is here.

@William-McGonagle
Copy link
Member Author

Oh- and the issue that all of this was created with is #36.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
No open projects
Status: Todo
Development

Successfully merging a pull request may close this issue.

1 participant