-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Fix broken link in to Cirque documentation #6862
Fix broken link in to Cirque documentation #6862
Conversation
79da4a5
to
78df0f8
Compare
Status Although launching locally Action |
What version of doxygen are you running locally? This looks a lot like doxygen/doxygen#8130 which was just fixed a few months ago. Fix is in doxygen 1.9.0, but our containers are running doxygen 1.8.17, afaict. |
Hi @bzbarsky-apple, Before I make any correction, what do you think, or any other of the project of course, would be the best way forward ?
Considering that with option C and D the documentation has broken links in this phase of adoption. Let me know, cheers, have an outstanding week, F |
My gut feeling is that if we can do the doxygen update in our container in general, not on a per-workflow basis, that would be ideal. I guess that's option B, right? @woody-apple How feasible is that? |
I have created this PR to automate the validation of broken links, hopefully that helps to early detect these issues. |
@electrocucaracha great. |
/rebase |
78df0f8
to
f6af7b9
Compare
Problem
The user, when cliicking on the link to the Cirque's README documentation page, was landing on a 404 Github page, due to an invalid relative link.
Summary of Changes
The link is fixes, and the documentation navigation is now working correctly.