-
Notifications
You must be signed in to change notification settings - Fork 523
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
Relative vs. absolute links? #1123
Comments
💯 Relative links all the way - I've seen members commenting in this repo many times that we use relative links as standard. Those absolute links must be old and slipped through our 👀 back then. There's no reason I can see to not do a clean up there, except for the generated docs - I don't have a clear understanding on what would be needed to change those to relative (it might not be possible, actually, due to how the folder is structured, but I don't know 🤷 ) A PR to update this throughout our docs would be amazing ❤️ |
Noted! 🎉 I've inspected a couple of not so ancient git blames… and it seems it creeps randomly in in lieu of copy&pastes etc., so I've been indeed meaning to prune the absolutes, simply to avoid any further copy paste leftovers for now. (Will keep this issue open until I find some quality time to spend with preview builds, to try to make sure all the changes don't cause anything weird…) I think I'll keep the generated docs as-is for now, but will poke around what the viable scenarios might be, eventually. |
A reason from the olden days could be that this docs project evolved from .md files in the main repo in the beginning, so some of the pages might have been used in 2 places at the same time. Should not be the case any more though. |
So I'm slowly mapping how the links are used, and besides the absolute links with production domain included in them, there are also "relative" absolute links that are far more common around here — e.g. With mkdocs now updated to the newest version, it prints out all sorts of similar info lines in the logs:
|
So I am just curious… is there a general consensus or a pattern to follow what insite links should be relative like:
docs/docs/getting-started/ios/setup.md
Lines 44 to 48 in 84b76c0
and what should link absolutely as e.g.:
docs/docs/getting-started/ios/beta-deployment.md
Line 189 in 84b76c0
docs/docs/getting-started/ios/beta-deployment.md
Line 153 in 84b76c0
docs/docs/best-practices/continuous-integration/codemagic.md
Line 7 in 8f70ddb
I'm asking because on a few occasions I was tempted to propose a fix/cleanup for there, only to realise I'm not sure about any internal styleguide that would explain these discrepancies…
(The only pattern I've noticed is that /generated/ docs have the absolute URLs in them more often.)
Why I'm really raising this topic is… anywhere you leave absolute links, you:
The text was updated successfully, but these errors were encountered: