p4lang / p4c

P4_16 reference compiler

https://p4.org/

Apache License 2.0

641 stars 428 forks source link

Broken link to Migration guide in doxygen-generated docs #4753

Open jafingerhut opened 1 week ago

jafingerhut commented 1 week ago

Go to this page: https://p4lang.github.io/p4c/md_01__overview.html

In the last bullet item there is a link "migration guide". When I click on it as of 2024-Jun-24, I get a 404 error page from the server.

The link appears to be a correct Github-flavored Markdown link in the docs/README.md file, so ideally there should be a way to leave the link in the file docs/README.md as it is now, but change how doxygen processes the link when generating HTML.

This is not necessarily the most critical issue to fix in the documentation, but I wanted to record it.

jafingerhut commented 1 week ago

There are some more broken links on the P4Smith page, in particular the ones with the link text listed below:

targets/generic
targets/bmv2
targets/pna
targets/ebpf

It looks like several of those are correct Github-flavored Markdown links to files within the p4lang/p4c repository, but they are not being translated into corresponding links by doxygen in the HTML.

AdarshRawat1 commented 1 week ago

I searched for workarounds, but the best way I could find was to use direct link to PPT . i.e. [Migration Guide](https://github.com/p4lang/p4c/blob/main/docs/migration-guide.pptx)

Context

There is an option to copy the files to the root of the generated HTML, but it still breaks the link, as our HTML and PPT are on the same level. [Reason - Current link is not pointing to same level.]

We can fix this by pushing the generated HTML to a docs Dir and then copying all resource files to root. Note : That this can only fix file links which are one dir level above. i.e. Not very flexible.