Enhanced Internal linking for auto-pushed API docs
under review
Kevin Papp
In markdown, one can add a hyperlink through <description>, where link can either be an http/https address, or a relative link. Relative links will resolve to the same domain (e.g. if my article is https://
.document360.io/docs/foo, then links to ./bar link to https://
.document360.io/docs/bar). Knowing this, here are the 3 key facts which cause us problems:- The article URLs on doc360 are flat (ie all are under /docs/article-slug), and duplicate slugs are resolved by appending -2, -3, etc to the end of URL
- We have multiple categories set up with the same articles per dev environment (master, qa, rc, preview, production) which each want their articles to reference other articles within the same category
- It is not really possible to resolve the number suffixes dynamically, or at least this is very impractical and causes other issues.
The ideal feature would be to have article URLs in doc360 take on a folder structure for categories, i.e. include the category structure in the URLs (or have the option to do this).
An alternative feature would be to allow relative links to reference based on the article/category structure instead of the URL structure, though this solution is not as clean.
Log In
V
Vishnu bala
under review