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

Documentation! #2

Open
bahorn opened this issue May 25, 2020 · 4 comments
Open

Documentation! #2

bahorn opened this issue May 25, 2020 · 4 comments
Assignees
@bahorn
Labels
documentation Improvements or additions to documentation

Comments

@bahorn
Copy link
Owner

bahorn commented May 25, 2020

I've just been setting up readthedocs page and now need to start writing up some useful documentation.
@bahorn bahorn added the documentation Improvements or additions to documentation label May 25, 2020
@bahorn bahorn self-assigned this May 25, 2020
@bahorn bahorn mentioned this issue May 25, 2020
Open
4 tasks
@bahorn
Copy link
Owner Author

bahorn commented May 25, 2020

I started work on this in the docs branch

@bahorn
Copy link
Owner Author

bahorn commented May 25, 2020 •
edited
Loading

Progress:

  • Setup a readthedocs page
  • Setup auto document generation of the classes
  • Finish the Getting Started overview
  • Write up the protocol spec
  • Add docstrings throughout the codebase to aid the autodocumentation

@bahorn
Copy link
Owner Author

bahorn commented May 25, 2020

Merged in some of progress so far.

@bahorn
Copy link
Owner Author

bahorn commented Jun 8, 2020

This needs to be updated to represent the better UX I implemented earlier.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bahorn bahorn

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bahorn