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

Updated Documentation for v1.0.0 release #18

Closed
5 tasks
felixnext opened this issue Jan 25, 2023 · 0 comments · Fixed by #20
Closed
5 tasks

Updated Documentation for v1.0.0 release #18

felixnext opened this issue Jan 25, 2023 · 0 comments · Fixed by #20
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@felixnext
Copy link
Owner

#10 brings the lib to the alpha stage, but we should update the documentation to be up to date.

Specifically this includes:

  • Bring code in readme up to date and simplify
  • Add "Technical Debt" section to the readme
  • Create docs folder and create a page for each sub-system
  • Create a section for extension
  • Create a section for contributors
@felixnext felixnext added the documentation Improvements or additions to documentation label Jan 25, 2023
@felixnext felixnext self-assigned this Jan 25, 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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant