asyncapi / generator

Use your AsyncAPI definition to generate literally anything. Markdown documentation, Node.js code, HTML documentation, anything!
https://asyncapi.com/docs/tools/generator
Apache License 2.0
770 stars 233 forks source link

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

Closed Gmin2 closed 1 week ago

Gmin2 commented 1 month ago

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 https://github.com/asyncapi/generator/blob/6f60d50f3e4544d7356e8b1c8dc40380dfb87ece/apps/generator/docs/index.md?plain=1#L6 the AsyncAPI Document relative path is not correct, it should be asycapi-document.md instead of generator/asyncapi-document

Code of Conduct

Shubham0523 commented 1 month ago

I would love to work on the issue please assign me

Gmin2 commented 1 month ago

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

Aryan4884 commented 1 month ago

@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 commented 1 month ago

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

Gmin2 commented 1 month ago

@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 commented 1 month ago

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

rajRishi22 commented 1 week ago

Hi @Gmin2 , I have fixed all links in index.js but i am unable to find the file migration.md , can you please send me path for that file.

Gmin2 commented 1 week ago

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

@derberg we should close this issue