chore: codebase refactoring and cleanup and documentation update #1886
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AayushSaini101
requested review from
Amzani,
Shurtu-gal,
Souvikns and
asyncapi-bot-eve
as code owners
|
Contributor
|
@asyncapi/bounty_team |
8 tasks
AayushSaini101
changed the title
Collaborator
Author
|
/u |
3 similar comments
Collaborator
Author
|
/u |
Collaborator
Author
|
/u |
Collaborator
Author
|
/u |
AayushSaini101
force-pushed
the
1853
branch
2 times, most recently
from
5bf59c2 to
2a5d404
Compare
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✅ 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
closes: Codebase refactoring and cleanup + documentation update #1853