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

[📑 Docs]: Fix the relative paths of index.md & migration.md files. #1294

Open
1 task done
Gmin2 opened this issue Oct 10, 2024 · 6 comments
Open
1 task done

[📑 Docs]: Fix the relative paths of index.md & migration.md files. #1294

Gmin2 opened this issue Oct 10, 2024 · 6 comments
Labels
📑 docs good first issue Good for newcomers Hacktoberfest Label issues as available for participants of https://hacktoberfest.digitalocean.com

Comments

@Gmin2
Copy link
Collaborator

Gmin2 commented Oct 10, 2024

What Dev Docs changes are you proposing?

In the index.md & migration.md there are many places where relative paths are wrongly placed(after the migration to monorepo) , fix the relative paths for this two particular file.

Example
In the

The AsyncAPI generator is a tool that generates anything you want using the **[AsyncAPI Document](generator/asyncapi-document)** and **[Template](generator/template)** that are supplied as inputs to the AsyncAPI CLI. The generator was built with extensibility in mind; you can use the generator to generate anything you want, provided that it can be defined in a template, such as code, diagrams, markdown files, microservices, and applications. A number of [community-maintained templates](https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate) are now available for immediate usage.

the AsyncAPI Document relative path is not correct, it should be asycapi-document.md instead of generator/asyncapi-document

Code of Conduct

  • I agree to follow this project's Code of Conduct
@derberg derberg added good first issue Good for newcomers Hacktoberfest Label issues as available for participants of https://hacktoberfest.digitalocean.com labels Oct 10, 2024
@Shubham0523
Copy link

I would love to work on the issue please assign me

@Gmin2
Copy link
Collaborator Author

Gmin2 commented Oct 12, 2024

We dont assign issues, just make a PR solving the issue

@Aryan4884
Copy link

Aryan4884 commented Oct 12, 2024

@Gmin2 Raised a PR. Have a look please.
Also I was unable to find migration.md file in the codebase.Let me know if I am getting something wrong.

@derberg
Copy link
Member

derberg commented Oct 14, 2024

@Gmin2 but the paths should be valid only for asyncapi.com, where docs are rendered, not here in docs

@Gmin2
Copy link
Collaborator Author

Gmin2 commented Oct 16, 2024

@Gmin2 but the paths should be valid only for asyncapi.com, where docs are rendered, not here in docs

yes @derberg, i need to change the issue to fix for only the path with github url, bcz i see in some places the github path is wrong after migrating to monorepo
should i edit this issue only? wdyt ?

@derberg
Copy link
Member

derberg commented Oct 21, 2024

not sure what links you have in mind exactly, can you share an example?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📑 docs good first issue Good for newcomers Hacktoberfest Label issues as available for participants of https://hacktoberfest.digitalocean.com
Projects
None yet
Development

No branches or pull requests

4 participants