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

Create a Documentation Website with API References and Code Samples #20

Open
3 tasks
noorbuchi opened this issue Jan 9, 2022 · 0 comments
Open
3 tasks
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@noorbuchi
Copy link
Collaborator

noorbuchi commented Jan 9, 2022

Task Description and Info (what needs to be done?)

Although currently a high priority task, it would be very nice to have a documentation website that contains all the API references, functions, instance variables with clear descriptions. The website should be able to generate documentation automatically and be updated automatically when merges are made to the main branch. Many tools exist to do this but further search is needed to determine which would work best for the project.

Acceptance Criteria (when is it considered complete?)

Need more search before they can be determined

  • Criteria 1
  • Criteria 2
  • Criteria 3

Time to complete (approximately, how much time will this take?)

October 13th (~2 weeks)

Person/People involved (who is working on this?)

@aveetdesai
@brum0505
@ningerson2002
@BillOchieng

Other information

Anything else that doesn't fit in previous categories

@noorbuchi noorbuchi added documentation Improvements or additions to documentation task On Hold Don't work on this yet labels Jan 9, 2022
@noorbuchi noorbuchi changed the title [TASK] Create a Documentation Website with API References and Code Samples Create a Documentation Website with API References and Code Samples Sep 5, 2022
@noorbuchi noorbuchi removed the On Hold Don't work on this yet label Sep 5, 2022
@aveetdesai aveetdesai assigned aveetdesai and unassigned aveetdesai Sep 29, 2022
@BillOchieng BillOchieng self-assigned this Sep 29, 2022
@aveetdesai aveetdesai assigned aveetdesai and unassigned BillOchieng Sep 29, 2022
@ningerson2002 ningerson2002 self-assigned this Sep 29, 2022
@brum0505 brum0505 self-assigned this Sep 29, 2022
@jjumadinova jjumadinova moved this from Todo to In Progress in SheetShuttle Contributions Nov 11, 2022
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
Projects
Status: In Progress
Development

No branches or pull requests

6 participants