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

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

Closed
jafingerhut opened this issue Jun 24, 2024 · 4 comments
Closed

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

jafingerhut opened this issue Jun 24, 2024 · 4 comments
Labels
documentation Topics related to compiler documentation.

Comments

@jafingerhut
Copy link
Contributor

jafingerhut commented Jun 24, 2024

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 jafingerhut added the documentation Topics related to compiler documentation. label Jun 24, 2024
@jafingerhut
Copy link
Contributor Author

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
Copy link
Member

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.

@AdarshRawat1
Copy link
Member

@jafingerhut
Copy link
Contributor Author

All of the links reported in my original issue are working reasonably now in the version generated and published here https://p4lang.github.io/p4c/index.html after this PR was merged in: #4793

Thus, closing this issue. I will create a separate issue for some other links I added in a follow-up comment, that are still currently broken.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Topics related to compiler documentation.
Projects
None yet
Development

No branches or pull requests

2 participants