Improve documentation/help command

[hoangong]

Hi,

I'm new to bloop and trying to learn things but some parts lack of documentation making hard for new user get started. For example, CLI page does not tell exact what is each command for. Some parameters in CLI is also unclear such as bloop autocomplete --mode <value> I'm not sure what is possible value there.

Can someone have good understand add more documentation?

[jvican]

Hi @1Mdc, thanks for reporting! Have you checked out https://scalacenter.github.io/bloop/docs/cli-reference ?

[hoangong]

Hi @jvican , thanks for getting back to me.

Yes I looked at that page. Can you please add a short description for each of the command?

Some of them are quite obvious e.g. bloop run/test. I don't know exact purpose some others.

Thanks.

[rorygraves]

N.b. correct link is: https://scalacenter.github.io/bloop/docs/cli/reference

[caenrique]

referenced documentation is unclear. Eg:

--mode (type: mode)

What are the posible values for type mode?

[ajkaanbal]

Posibble values for mode are

- commands,
- projects,
- projectboundcommands,
- flags,
- reporters,
- protocols,
- testsfqcn,
- mainsfqcn

I found them here: https://github.com/scalacenter/bloop/blob/main/frontend/src/main/scala/bloop/cli/completion/Mode.scala#L7

I saw that docs/cli/reference is autogenerated and it works fine for format but not for mode,
maybe something like this is missing, I'm not sure.