docs: update usage documentation for new commands

[mhmohona]

Description

The script is been added has following workflow -

• Create and update temp README file
• Generate command help documentation using oclif
• Extract usage information from README
• Update the usage.md file with the extracted usage information and a header
• Append the contents of the README file to the end of the usage file
• Remove the temp README file

Related issue(s): Resolves: #123

cc: @derberg

[derberg]

just had a great call with @mhmohona on how this PR can be improved 💪🏼

[mhmohona]

just had a great call with @mhmohona on how this PR can be improved 💪🏼

Thank you so much for your amaizing guideline @derberg ^_^

[derberg]

left two more comments

I think it would make sense to add some note in readme, in development guide section (if we have one, if not, just create) that the given markdown file should not be edited manually as it is generated by the CI

unless we can just generate inside usage.md file some kind of note about it, a note that will be visible in markdown but not on the website, would have to be between <!-- AUTOGENERATED and info how -->

what do you think?

[derberg]

@mhmohona so what do you thinks about my comment concerning readme or <!-- AUTOGENERATED and info how -->

[mhmohona]

@derberg oh, i typed the reply and forgot to click on comment button :3
Yes, its a great idea! I think in script it should be added instead of readme to keep readme clean which will make users be able to focus. Also how about having a separate doc for something like developer's guild? There all these details would be added so some individual who wants to contribute will easily be able to understand whats going on.

I was also thinking of writing a blog about on which approach I first wanted to go and later on what happened.

[derberg]

@mhmohona definitely sounds good but that is a stuff for separate PR for sure

[derberg]

Awesome work, so let's merge and see what will happen 😄

I will change PR title from feat: too docs: as this is not a library relevant change that requires a release of new CLI version.

now, I just noticed we do not have in CLI an automation that would run assets generation without release

please copy to this repo this workflow -> https://github.com/asyncapi/generator/blob/master/.github/workflows/update-docs-on-docs-commits.yml

and I will suggest additional improvements

but basically

# PR should be created within this GH action only if it is a docs: commit
# Otherwise it will conflict with release workflow
if: startsWith(github.event.commits[0].message, 'docs:')

should be moved under:

name: 'Generate docs and create PR'

and

on:
  push:
    branches:
      - master

should be changed to

on:
  push:
    branches:
      - master

[derberg]

LGTM 🚀

let's merge and see if automation works and usage.md will be updated

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[derberg]

/rtm

[asyncapi-bot]

🎉 This PR is included in version 0.45.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀