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

Link checker limitations #2904

Open
kodebach opened this issue Aug 22, 2019 · 3 comments

Comments

@kodebach
Copy link
Contributor

commented Aug 22, 2019

I'm not 100% sure how our link-checker (more specifically the markdown link converter) works, but there are some limitations. It would be nice, if we could get rid of them.

For example this run failed even though the link is technically correct.

If I understand things correctly, we need to generate { #header } tags not only for the title, but also for subtitles in markdown files for this to work.

@markus2330

This comment has been minimized.

Copy link
Contributor

commented Aug 23, 2019

Thank you for your report!

Until recently anchors were not supported by the website #2450

I am still not sure if it now works for all our markdown targets (ronn?, qt-gui?)

Until someone verifies that it actually works for all our markdown implementations, it is better to keep the link checker strict.

@markus2330 markus2330 added the proposal label Aug 23, 2019

@kodebach

This comment has been minimized.

Copy link
Contributor Author

commented Aug 23, 2019

I am still not sure if it now works for all our markdown targets (ronn?, qt-gui?)

Are tutorials rendered anywhere else apart from the website? I think it would make sense to allow anchors for the files that are only displayed on the website.

@markus2330

This comment has been minimized.

Copy link
Contributor

commented Aug 24, 2019

Are tutorials rendered anywhere else apart from the website?

At least GitHub and Doxygen also renders them.

As we sometimes move around text, I think it is easier if we use the same syntax everywhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.