docs: update maas-anvil documentation

[dgtlntv]

Updates the documentation in the README file. To see a rendered version of the changed markdown see the README in my fork.
Related Jira epic

[dgtlntv]

@skatsaounis Do you think we should wait with merging this PR until we have updated the help messages for the commands so they are the same as the CLI Interface section in these docs?
Also could you maybe add @billwear as a reviewer to this PR? I am not able to add reviewers myself.

[skatsaounis]

@skatsaounis Do you think we should wait with merging this PR until we have updated the help messages for the commands so they are the same as the CLI Interface section in these docs? Also could you maybe add @billwear as a reviewer to this PR? I am not able to add reviewers myself.

@dgtlntv I have added Bill as a reviewer. What changes are we talking about? #72, #74? Both of them were resolved with the PRs that got merged today. Unless there is something more than that

[dgtlntv]

@skatsaounis In the docs in the PR under "CLI interface" I changed some of the descriptions of the commands, options. They are different from what would currently be displayed when you type --help for a command. I thought that we could update the help pages of the commands as well to the improved version outlined in the docs.

[wyattrees]

looks good with some minor comments

[wyattrees]

one last update

[wyattrees]

We've changed the manifest a bit with TLS passthrough being merged today, so I added some suggestions to make things consistent here and add some more explanation

[dgtlntv]

@skatsaounis As discussed I have update the PR to also include updates to the help pages in the CLI. I had to do some custom formatting for the Commands/Groups to get the desired format of the help pages. Specifically click does not seem to have a native way to group commands in the help page and indents epilog text by default.
Do you think it is ok to add this to get nicer looking help pages? If yes could you help me resolve the linter issues? I am not too familiar with coding with types in python 😅

[skatsaounis]

@dgtlntv I rebased to current main and I also fixed all linting issues.

I have only a request for you. It seems that you are using the Markdown header levels as a convenient way to set the font size. Could you please fix them so that Only one # exists and also every child of a parent header is at most one level greater. For example, # can have only ## children, instead of ##### or any other level. This is the only linting issue that remains.

Finally, could you please get the produced snap, install it locally and confirm that the help text is displayed as expected?

As far as coding is concerned, I am happy to give my +1 when you take care of the above things. For the docs content, you may still chase an approval from @billwear

Thank you for your great work so far 🚀

[dgtlntv]

@skatsaounis I have addressed your change requests and reviewed all help pages with a locally built snap. It looks good from my side now!

[skatsaounis]

LGTM +1 nice job. Please get also approval from @billwear or acknowledge that we can merge without it. Afterwards, we will merge this PR

[billwear]

these are all docstrings. there is no canonical standard for these, so nothing to review.

[wyattrees]

LGTM!