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

More docs #82

Merged
merged 9 commits into from
Aug 31, 2023
Merged

More docs #82

merged 9 commits into from
Aug 31, 2023

Conversation

grigi
Copy link
Contributor

@grigi grigi commented Aug 31, 2023

Wrote a lot more docs.

I'm going to have to pause here for a while. I mostly wrote the docs to help myself understand the project better. Even with the few TODO's littered around the docs are significantly better already.

You can browse them locally by running make devdocs if you want to see.

Done:

  • Updated the docstrings to be parseable whilst keeping the syntax human readable
  • Added docstrings where I thought it would be needed
  • Added changelog (incomplete, only goes back to 0.6.0)
    Placed CHANGELOG.md in the project root and referenced it so we don't have duplications and hopefully it's easy to spot.
  • Improved docs landing page
  • Improved docs layout
  • Added Usage section that has guides on different subjects
  • Noted where I feel docs are needed but I didn't get round to it

@tobymao tobymao merged commit cb178cb into tobymao:master Aug 31, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants