search

reactioncommerce / redoc

redoc - generate documentation from multiple project repos.
GNU General Public License v3.0
20 stars 11 forks source link

local path link handling #78

Open aaronjudd opened 7 years ago

aaronjudd commented 7 years ago

local path links are not working in many of our documents. We need to document/explain/fix this strategy to get all our local paths working.

The problem:

We're currently seeing failing links like:

https://docs.reactioncommerce.com/reaction-docs/development/configuration.md

a working version of this link is:

https://docs.reactioncommerce.com/reaction-docs/development/configuration

It seems to work when the last segment in the path matches the last segment of a docPath defined in redoc.json.

machikoyasuda commented 7 years ago

Another example of linking bugs:

https://github.com/reactioncommerce/reaction-docs/blob/master/developer/tutorial/introduction.md 's first link to the style guide fails, but https://github.com/reactioncommerce/reaction-docs/blob/master/developer/styleguide.md works. All the rest of the links without the .md appended fail as well, like here: https://github.com/reactioncommerce/reaction-docs/blob/master/developer/tutorial/introduction.md#how-do-i-change-the-layout