console: document views

[hawkw]

What problem are you trying to solve?

Currently, there isn't a lot of documentation that actually explains how to interpret the console's various views. In particular, it would be good to actually discuss what the different columns in the tasks and resources views actually mean. For example, @hdevalence mentioned being confused by the Viz column in the resources view — the meaning of the emojis is not immediately obvious.

How should the problem be solved?

We should add some new documentation to the RustDoc for tokio-console describing what these views mean and how to interpret them. In particular, we should describe the different columns and what they represent.

Any alternatives you've considered?

We may also want to use the help view added by @bIgBV in #243 to display this documentation. It would be nice if the same markdown file could be included in both the help screen at runtime and in the RustDoc, so we don't have to update documentation in two places...

How would users interact with this feature?

No response

Would you like to work on this feature?

maybe

[faro-dr]

In the meantime, is the information what the cloumns mean out there somewhere?

[hds]

@faro-dr It's on the docs.rs main page for tokio-console. 😎

https://docs.rs/tokio-console/latest/tokio_console/

There are a couple of changes which I've just realised are not correctly reflected in the tasks list view (Target column has been replaced by Kind - but the meaning of kind is documented under Fields, which is where the value of Target has gone now).

[faro-dr]

Oops, how could I overlook this 😳 Thanks @hds