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

Write the API Documentation on the wiki #27

Closed
4 of 6 tasks
dubdabasoduba opened this issue Feb 27, 2023 · 0 comments
Closed
4 of 6 tasks

Write the API Documentation on the wiki #27

dubdabasoduba opened this issue Feb 27, 2023 · 0 comments
Assignees
Labels
Documentation Improvements or additions to documentation LIbrary The prosposed changes affect the Library

Comments

@dubdabasoduba
Copy link
Collaborator

dubdabasoduba commented Feb 27, 2023

Context

  • We need to clearly communicate how to use the API.

Implementation

  • Write the following pieces of documentation.
    • Getting started. This includes how the add the project as a dependency and the configs to add to the local.properties
    • Document how to use the APIs #61
    • Update the code standards documentation.
    • Update the contributions documentation

Acceptance criteria

  • A new person should be able to pick up the library and start using it based on the documentation on the wiki
@dubdabasoduba dubdabasoduba added Documentation Improvements or additions to documentation LIbrary The prosposed changes affect the Library labels Feb 27, 2023
@dubdabasoduba dubdabasoduba self-assigned this Feb 27, 2023
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 LIbrary The prosposed changes affect the Library
Projects
None yet
Development

No branches or pull requests

1 participant