documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Ability to link by relative paths

Open rmglennon opened this issue 8 years ago • 0 comments

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.

rmglennon avatar Oct 20 '17 18:10 rmglennon