Relative URLs in Markdown Only Work in Master Branch

Issue #18231 new
Jonathon Richardson created an issue

As noted in Issues #6315 and #6589, relative URLs from markdown files were only fixed for the master branch.

I'm opening this because #6315 is marked resolved and #6589 is marked as a duplicate, so I don't think this aspect of the issue is actually being tracked.

This causes problems when trying to document your projects using multiple files. First, it means that you have to merge to master before you can actually browse the documentation, which doesn't work well for large projects that have significant changes in branches which require different documentation.

Secondly, it can actually cause issues when you browse your branch's README.md file and then click a link to a sub page. You'd think you're looking at the most recent version of that documentation in that branch, but it actually redirects you to master's version of that file. This means you can be reading outdated documentation and thinking it's up to date, which causes frustration and confusion.

Comments (1)

  1. Log in to comment