Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fixing docs with some replacements #1325

Conversation

Bharath-dev05
Copy link

@Bharath-dev05 Bharath-dev05 commented Dec 15, 2024

issue#1322

Description
replaced @asyncapi/html-template with @asyncapi/[email protected] --use-new-generator

Check the issue once for more information.

Related issue(s)
Fixes #1322

Copy link

changeset-bot bot commented Dec 15, 2024

⚠️ No Changeset found

Latest commit: 12c5cdc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@Bharath-dev05 Bharath-dev05 changed the title fix: Fixing docs with some replacements fix: fixing docs with some replacements Dec 15, 2024
@derberg
Copy link
Member

derberg commented Dec 16, 2024

Sorry but to help maintainers in open source you need to make a bit more effort than just simple find and replace.
I will close this PR, if you are still interested in helping, which would be great, please, after doing find and replace, actually read the docs that you modified. Not everywhere the change needs to be done. Please take time to understand the problem and then apply the fix.

side not that is not obvious: api.md is a generated file, from code comments, so do not modify it, but modify code comments where needed

@derberg derberg closed this Dec 16, 2024
@Bharath-dev05
Copy link
Author

Bharath-dev05 commented Dec 16, 2024

Thank you for the feedback and for pointing out the mistakes regarding the changes. I appreciate the detailed explanation and your patience.
I understand now that simple find and replace is insufficient. I'll revisit the documentation, read through the relevant sections carefully, and make necessary adjustments with a better understanding of the Problem.

I also noted your point about api.md being a generated file.

Thanks again for guiding me through the process, and I look forward to contributing effectively to this project!.

@Bharath-dev05 Bharath-dev05 deleted the fix-docs-by-replacing-@asyncapi/html-template-with-@asyncapi/[email protected] branch December 16, 2024 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Cannot run the generator using the commands in the documentation
3 participants