docs: Improve command documentation

[mmarseu]

Changes to available_commands.md:

• Move the build-public section to where it should be alphabetically.
• Update documentation for add-license-text operation. This should have been done in #160 but it was forgotten.
• Rewrite of validate documentation.
  • Include CycloneDX version support.
  • Describe effect of --schema-path on filename validation.

[github-actions[bot]]

Coverage Report •

File	Stmts	Miss	Cover	Missing
TOTAL	1610	71	95%

report-only-changed-files is enabled. No files were changed during this commit :)

Tests	Skipped	Failures	Errors	Time
287	2 :zzz:	0 :x:	0 :fire:	4.467s :stopwatch:

[CBeck-96]

Are there plans to also add the other commands beside add-license-text to the documentation at a later time?

[mmarseu]

Are there plans to also add the other commands beside add-license-text to the documentation at a later time?

That's a valid point. I've only reworked the add-license-text section because it was already there. It could be argued that either we document all operations or none at all. Certainly, add-license-text is a little more complex than the others because it requires the user to provide files in a certain form. Ideally, we'd be able to automatically include the docstrings from the operation classes into the documentation. Possibly via #177?

[CBeck-96]

That's a valid point. I've only reworked the add-license-text section because it was already there. It could be argued that either we document all operations or none at all. Certainly, add-license-text is a little more complex than the others because it requires the user to provide files in a certain form. Ideally, we'd be able to automatically include the docstrings from the operation classes into the documentation. Possibly via #177?

I think for now thats a sufficient argument. The documentation for the easier/more intuitive to use operations can wait till we made progress on #177.

[italvi]

@mmarseu Please resolve the conflict, otherwise no further comments 😁