About contributing about python-statemachine

[fgmacedo]

Hey @iamgodot , thanks for your interest in helping improve our docs.

I'm following the git flow branching convention. So the main is the current release, and the develop branch is for the next version.

I'm planning to release a new major (2.0) this weekend, due to a few breaking changes on the API. So the develop branch will be merged back to main on this release. This is the release notes so far: https://python-statemachine.readthedocs.io/en/develop/releases/2.0.0.html

The develop docs can be seen here: https://python-statemachine.readthedocs.io/en/develop/

There's also a helping guide on setup instructions: https://python-statemachine.readthedocs.io/en/develop/contributing.html#get-started

If you’re especially writing documentation, I strongly recommend using sphinx-autobuild as it improves the workflow watching for file changes and with live reloading:

poetry run sphinx-autobuild docs docs/_build/html --re-ignore "auto_examples/.*"

You're very welcome, please feel free to ask me anything.

Best regards,

[iamgodot]

Ah..Thanks for the explanation, I get it. And I can see that typos are fixed in the upcoming release.
BTW, great project, I'm looking forward to see the new API and hoping to contribute next time :)