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

Ability to link by relative paths #334

Open
rmglennon opened this issue Oct 20, 2017 · 0 comments
Open

Ability to link by relative paths #334

rmglennon opened this issue Oct 20, 2017 · 0 comments

Comments

@rmglennon
Copy link
Member

Right now, to link from one section of the help to another (say, from Mobile to Mobility), the link has to be hard-coded as a full, absolute URL path. The documentation system should be smarter and link by some kind of relative path; ideally, it would link to a GUID so the link continues to function if the file moves or the URL changes.

This serves many purposes:

  • ability to version URLs for latest and previous releases
  • ability to change URLs to reflect language (such as en, de, and so on)
  • ability to maintain links when source file names change

It may be rather complicated with documentation spread across multiple repositories, but will save some grief.

This has been a long-standing problem with documentation, yet I could not find an issue at the moment.

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

No branches or pull requests

1 participant