Documentation for users of invoke based projects

[paddymul]

I was onboarded to a project that uses invoke. The README had instructions of install invoke, then run invoke setup.

As my first interaction with the project, even after reading through the documentation, I was a bit lost as to what that command would actually do, or what configuration file controlled the setup task.

It would have been useful if your instructions included a section for "users of invoke".
with sections like this

Disect an invoke command

invoke setup
invoke searches for the setup.py? setup.cfg file and runs the tasks inside.

How to dry run an invoke command

....

---

The docs are written with a view of explaining how to setup invoke to run tasks for a project. There is a whole extra set of users who will run invoke but won't set it up.