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.

Sign up for GitHub

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

Jump to bottom

Create Separate Usage Docs #92

Closed
ijemmao opened this issue Oct 9, 2020 · 2 comments
Closed

Create Separate Usage Docs #92

ijemmao opened this issue Oct 9, 2020 · 2 comments
Assignees
@oemekaogala
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Igbo Dictionary API

Comments

@ijemmao
Copy link
Collaborator

ijemmao commented Oct 9, 2020

Currently, all the documentation on how to interact with the API is in the README.

That information should be moved out to its own doc. Maybe a USAGE.md file or create a new page in the Wiki.

Maybe we explore using automatically generating API docs with packages like apidoc
@ijemmao ijemmao added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 9, 2020
@oemekaogala
Copy link
Contributor

I can take a stab at this!

@ijemmao ijemmao added this to To do in Igbo Dictionary API Oct 9, 2020
This was referenced Oct 13, 2020
Closed
Merged
@ijemmao
Copy link
Collaborator Author

ijemmao commented Oct 16, 2020

This ticket has been addressed by the linked PR.

@ijemmao ijemmao closed this as completed Oct 16, 2020
Igbo Dictionary API automation moved this from To do to Done Oct 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@oemekaogala oemekaogala

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Igbo Dictionary API
Done
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ijemmao @oemekaogala