Optimal documentation suggestions

[kevlar700]

This has turned into two possible suggestions that aren't necessarily exclusive.

The current documentation is quite good but I find it can take time and experimentation to work some things out currently such as alire.toml build-profiles and build-switches. I guess the problem there pertaining to the second config/man page related suggestion is that atleast build-profiles depends on particular crate names. Though it may work for build-switches and the gprbuild config file.

First perhaps easier suggestion:
Alire could open relevant documents such as the gprbuild manual in a selected/provided browser. I would install Alire on my tablet just for that feature of easy access to up to date documents. If they could be cached for offline use then even better.

Second suggestion
OpenSSH is quite complex but the documentation is rather good atleast on OpenBSD. Linux seems to prefer websites but OpenBSD is praised for it's documentation.

The man page tells you what each or atleast most possible configuration lines do

see "https://man.openbsd.org/sshd_config"

The default /etc/ssh/sshd_config file has I assume well chosen commented lines that demonstrate the default values so when uncommented nothing changes until you edit the line.

see "https://github.com/openssh/openssh-portable/blob/master/sshd_config"

As well as being on Unix, the man command searches help on windows these days too but I expect that route to be problematic in a number of ways. I wonder if alr could have a man argument and provide documentation such as possible configuration options.

e.g.
alr --manual alire.toml
alr --manual main.gpr?
alr --manual without argument could provide a list of available manuals

[mosteo]

Yes, making some info more immediate is something I miss to at times.

At some point we'd like to have an schema for alire.toml, that would help with editors like vscode that can leverage that to check syntax and provide completions.

We already have alr help <topics> for things that aren't a command. We could use that for alr help alire.toml or alr help manifest. Also, these days we can easily embed a file into alr so having a fully populated alire.toml printable on demand is not a tall order.

[kevlar700]

Sounds good. Documentation is often a pain. Alire is working well for me though. Thank you