Add docs to Mix tasks

[joustava]

Made changes to the Mix task implementations so that

• mix help will now list the available atomvm.* task
• mix doc will generate ex docs

Am not sure how to word the moduledoc for the check task though, feedback welcome.

Closes #40

[petermm]

Looking good, I would back out the readme changes - pending other PR, or wait for it to land and rebase..

And then just the minor nitpicks..

Thanks!

[UncleGrumpy]

The check task, if you want to document it verifies that the functions and modules used are either part of the application source (or deps) or supported by AtomVM. This will catch the use of any standard Elixir modules or functions used in the application that are not included in exavmlib.

The packbeam task depends on this one, so users will likely never need to use it directly, but just in case they are wondering what it is doing a short module doc description wouldn’t hurt.

[UncleGrumpy]

To add a signoff to your commit you can use:

git commit --amend --signoff

…or the short option -s to add the sign off.

[petermm]

Let's back out mix.lock and it should be good to go.

Adding it at this stage only creates issues, and solves none. (eg is this mix.lock valid on elixir 1.X), will it load outdated ex_doc, once we start using that etc.

Surely we will add mix.lock once it's beneficial, but even then it may be sideloaded in Docs CI - since elixir 1.7-1.19 is theoretically supported, and I foresee a mix.lock conflicting with that, I could just be imagining that, but I'm not gonna investigate.

[petermm]

great work @joustava - thank you, and apologies for things not being straightforward...

[joustava]

Is this waiting for my input?

[UncleGrumpy]

Is this waiting for my input?

No, I believe everything is good on your end. We just need to have @bettio review and handle merging.