Codebase refactoring and cleanup + documentation update

[AayushSaini101]

Title: 📚 Update CLI Documentation to Reflect New Architecture, Debugging, and Testing Procedures

Description

The architecture of the AsyncAPI CLI has recently undergone major changes, including the addition and update of commands, as well as improvements in services and APIs. As a result, the existing documentation is outdated and lacks essential information around debugging, testing, and understanding the CLI’s flow.

Many contributors have faced difficulties navigating these changes and contributing effectively. Updating the documentation will help provide clarity, improve debugging workflows, and onboard new contributors more smoothly.

✅ Tasks

• Update the AsyncAPI CLI Introduction section with diagrams
  Include explanations and visuals of new and updated commands.

• Document the updated CLI architecture [ Need to write again from scratch ]
  Explain services, APIs, interactions, and workflows with diagrams and examples and the Server API concept : )

• Revise the usage documentation
  Update CLI Usage

• Updater Documentation with new commands, flags, and parameters.

• Add debugging steps [ Debugging and writing test cases are very hard ]
  Provide step-by-step debugging and testing guidelines across all services and APIs.

• Document best practices for contributing via PRs
  Provide a checklist and guidelines to help contributors submit high-quality pull requests.

• Codebase Refraction and Cleanup

• Outline future requirements and scope
  Add notes about upcoming improvements, feature requests, and areas open for contribution.

📦 Additional Context

• Updating this documentation will:
• Reduce confusion and troubleshooting time.
• Improve contributor experience.
• Help onboard new contributors faster.
• Encourage consistent and high-quality contributions.

✅ Code of Conduct

I agree to follow this project's Code of Conduct.

🚀 Are you willing to work on this issue?

Yes, I am willing to submit a PR and collaborate with the team!

Let me know if you want it formatted as a GitHub issue template (.github/ISSUE_TEMPLATE/cli-docs-update.md) so it can be reused in the repository.

[AayushSaini101]

@Shurtu-gal @Souvikns Putting this for bounty willing to work : ) @neoandmatrix you can also suggest as well : )

[AayushSaini101]

More Reference: #1802

[Shurtu-gal]

I guess it is already being worked on by @Souvikns under #1802. We had discussed this in a meet as well.

Do we need to put this for bounty?
My proposal: onboard someone with good experience with docs and slowly show them the ins and outs, paving the path for a docs maintainer here as well.

[AayushSaini101]

I guess it is already being worked on by @Souvikns under #1802. We had discussed this in a meet as well.

Do we need to put this for bounty? My proposal: onboard someone with good experience with docs and slowly show them the ins and outs, paving the path for a docs maintainer here as well.

@Shurtu-gal I have good experience in writing the docs, i will write it properly as also we need to cover the CLI internals as well, I have already put this in the bounty will work on this : )

[aeworxet]

@AayushSaini101, could you please compare the approximate amount of future work to this PR of Medium level? Would it still remain Advanced?

[AayushSaini101]

@AayushSaini101, could you please compare the approximate amount of future work to this PR of Medium level? Would it still remain Advanced?

@aeworxet which PR is this https://github.com/asyncapi/community/pull/1894/files ?

[aeworxet]

@AayushSaini101
It was misperformed at the time, but it was still classified as Medium at the time of submission, so to keep estimates accurate I am assessing whether the amount of work on this issue exceeds that.

[AayushSaini101]

@AayushSaini101 It was misperformed at the time, but it was still classified as Medium at the time of submission, so to keep estimates accurate I am assessing whether the amount of work on this issue exceeds that.

We can consider as advanced because there are various part we need to perform in this issue

[aeworxet]

@thulieblack
Could you please assess the amount of work this issue would require? Would it fit the Advanced definition?
In fact, is it even Medium, and should it be submitted to the Bounty Program at all?

[AayushSaini101]

Sure let me edit the description:)

[thulieblack]

Hey, I have to agree with Ashish here #1853 (comment) this is a regular docs issue any contributor can do.

But if it really needs to be under the Bounty, then I suggest creating an outline and scope for the issue to justify why it isn't a regular docs issue but should be for Bounty.

[AayushSaini101]

@thulieblack @aeworxet @Shurtu-gal please review i have added some major improvements : )