generator icon indicating copy to clipboard operation
generator copied to clipboard

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

Open Gmin2 opened this issue 1 year ago • 6 comments

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

  • [X] I agree to follow this project's Code of Conduct

Gmin2 avatar Oct 10 '24 09:10 Gmin2

I would love to work on the issue please assign me

Shubham0523 avatar Oct 11 '24 18:10 Shubham0523

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

Gmin2 avatar Oct 12 '24 08:10 Gmin2

@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.

Aryan4884 avatar Oct 12 '24 14:10 Aryan4884

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

derberg avatar Oct 14 '24 09:10 derberg

@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 ?

Gmin2 avatar Oct 16 '24 08:10 Gmin2

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

derberg avatar Oct 21 '24 10:10 derberg

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.

rajRishi22 avatar Nov 12 '24 19:11 rajRishi22

@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

Gmin2 avatar Nov 14 '24 14:11 Gmin2