docs(iroh-cli): udpate doctor command documentation

[palozano]

Description

Update documentation to doctor command submodule.

This partially addresses #2660, and belongs to a series of PRs to complete it.

Breaking Changes

Notes & open questions

Imports have been formated to be grouped.

Change checklist

• Self-review.
• Documentation updates following the style guide, if relevant.
• Tests if relevant.
• All breaking changes documented.

[matheus23]

Thanks for this, can you use e.g. "Updates the progress bar" instead of "Update the progress bar" in general though? We've only recently adopted a new documentation style guide, so we're not super consistent at this yet, but we should try moving towards using it more.

The summary line should be written in third person singular present indicative form. Basically, this means write ‘Returns’ instead of ‘Return’.

I know it's easy to skip this sentence in the guide (I had to look for it a bit just now, too), but if you could update the PRs to use this style, it'd be great :)

[palozano]

Thanks for this, can you use e.g. "Updates the progress bar" instead of "Update the progress bar" in general though? We've only recently adopted a new documentation style guide, so we're not super consistent at this yet, but we should try moving towards using it more.

The summary line should be written in third person singular present indicative form. Basically, this means write ‘Returns’ instead of ‘Return’.

Completely missed this. Thanks!

I know it's easy to skip this sentence in the guide (I had to look for it a bit just now, too), but if you could update the PRs to use this style, it'd be great :)

Yeah, for sure.