You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
On the docs website, links to "root" markdown pages such as [Guides section](../guides/README.md) do not resolve to the docs website as root paths, rather they resolve to the github.com/garden-io/garden repository such as https://github.com/garden-io/garden/blob/latest-release/docs/guides/README.md.
Expected behavior
These links should stay relative to the docs website and should route to the intended destination without requiring a 301/302 from the root to a more specific page.
Reproducible example
There are 2 such links in the last paragraph of the https://docs.garden.io/using-garden/using-the-cli page:
Take a look at our [Guides section](../guides/README.md) for in-depth guides on specific use cases and setups, or keep exploring other sections under [Using Garden](./README.md) to learn more about Garden concepts and configuration.
The desired links an be inferred and browsed to manually as well as the docs being somewhat accessible/readable through the github markdown rendering feature.
Suggested solution(s)
Update all README.md links to the intended destinations such as the notes above
Update the docs rendering logic to render README.md links as root links
The text was updated successfully, but these errors were encountered:
Bug
Current Behavior
On the docs website, links to "root" markdown pages such as
[Guides section](../guides/README.md)
do not resolve to the docs website as root paths, rather they resolve to the github.com/garden-io/garden repository such ashttps://github.com/garden-io/garden/blob/latest-release/docs/guides/README.md
.Expected behavior
These links should stay relative to the docs website and should route to the intended destination without requiring a 301/302 from the root to a more specific page.
Reproducible example
There are 2 such links in the last paragraph of the
https://docs.garden.io/using-garden/using-the-cli
page:Guides section
actual: https://github.com/garden-io/garden/blob/latest-release/docs/guides/README.md
desired: https://docs.garden.io/guides
note: the desired link redirects to https://docs.garden.io/guides/migrating-to-bonsai
Using Garden
actual: https://github.com/garden-io/garden/blob/latest-release/docs/using-garden/README.md
desired: https://docs.garden.io/using-garden/
note: the desired link redirects to https://docs.garden.io/using-garden/configuration-overview
Workaround
The desired links an be inferred and browsed to manually as well as the docs being somewhat accessible/readable through the github markdown rendering feature.
Suggested solution(s)
README.md
links to the intended destinations such as thenotes
aboveREADME.md
links as root linksThe text was updated successfully, but these errors were encountered: