[BUG] Documentation improvements

[rcannood]

What happened?

There are parts of the documentation that could be improved:

• Argument groups needs an example, e.g.

  argument_groups:
  - name: Inputs
    description: Arguments related to input files.
    arguments: ...
  ...etc...

• Author example should be more complete, e.g.

  authors:
  - name: Jane Doe
    role: [author, maintainer]
    email: jane@doe.com
    info:
      github: janedoe
      twitter: janedoe
      orcid: XXAABBCCXX
      groups: [ one, two, three ]

• Computational requirements needs an example:

  requirements:
  commands: [...]
  cpus: 10
  memory: 10GB

• Dependency: Add an example from the perspective of the root of the config?

• Runners: Should get a better explanation of what adding runners does, at a high level.

• Engines: Should get a better explanation of what adding engines does, at a high level.

• Links: Example should be from the perspective of the config, that is, should be prefixed with links:.

• References: Example should be from the perspective of the config, that is, should be prefixed with references:. Also, perhaps change the description to something like: "A list of scholarly sources or publications relevant to the tools or analysis defined in the component. This is important for attribution, scientific reproducibility and transparency."

Steps to reproduce

/

Expected behavior

/

Relevant log output

/

Version

Viash 0.9

Possible solution

No response

Confirmation

• [X] I have searched the existing issues to make sure this is not a duplicate.
• [X] I have provided clear and concise information about the bug.

Additional context

No response