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:
[x] Updated the docstrings to be parseable whilst keeping the syntax human readable
[x] Added docstrings where I thought it would be needed
[x] 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.
[x] Improved docs landing page
[x] Improved docs layout
[x] Added Usage section that has guides on different subjects
[x] Noted where I feel docs are needed but I didn't get round to it
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 devdocsif you want to see.Done:
CHANGELOG.mdin the project root and referenced it so we don't have duplications and hopefully it's easy to spot.Usagesection that has guides on different subjects