mapzen / documentation

Configuration files, tools, and content to build Mapzen's documentation
https://mapzen.com/documentation
MIT License
25 stars 22 forks source link

Ability to link by relative paths #334

Open rmglennon opened 6 years ago

rmglennon commented 6 years ago

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:

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.