Skip to content
This repository has been archived by the owner on Nov 23, 2021. It is now read-only.

Recheck URLs in documentation #79

Open
maybeec opened this issue Apr 28, 2016 · 3 comments
Open

Recheck URLs in documentation #79

maybeec opened this issue Apr 28, 2016 · 3 comments

Comments

@maybeec
Copy link
Member

maybeec commented Apr 28, 2016

The source code layout has been changed meanwhile. So different links from the documentation to the source code are not valid anymore.
We have to check the documentation now regarding dead links.

@hohwille
Copy link
Member

It would be cool to have a way to link code in a refactoring safe way. A perfect solution could only be provieded by github in a complex way (tracking git links into git repos and tracking git code move and renames with hook to update wiki).
However we could also consider a way to just sematically express the linking of a Class by name in the wiki and have a generation that generates HTML and PDF with link on the actual Class.
In 95% already Classname is unique and sufficient info.

@amarinso
Copy link
Member

We could event automate things and look for broken links with an script.

I was curious and found this nice project:

https://github.com/stevenvachon/broken-link-checker

@hohwille
Copy link
Member

Can someone provide which links are actually broken? We have tons of tickets saying "we should ideally ..." or "it may be nice ...". In the end this is all spam and clutter. If no-one provides concrete input, I will close this in a while.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants