Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: all the getting started links are broken #191

baywet opened this issue Jul 10, 2019 · 2 comments


Copy link

commented Jul 10, 2019


  • Enhancement
  • Bug
  • Question


Please specify what version of the library you are using: Documentation related issue.

Expected / Desired Behavior / Question

Getting started link to point to the proper page (eg for this page

Observed Behavior

Getting started points to a in-existing page, (notice the controls path section which shouldn't be there)

Steps to Reproduce

Open this page click on Getting Started

Potential fixes

I'm not sure whether we should replace the link by ../#getting-started or (so MkDocs picks it up properly and replaces the link for us) or if a MkDocs configuration issue.
If it's not the last option, I'll be happy to PR away once I get guidance.


This comment has been minimized.

Copy link

commented Jul 10, 2019

Thank you for reporting this issue. We will be triaging your incoming issue as soon as possible.

estruyf added a commit that referenced this issue Jul 17, 2019


This comment has been minimized.

Copy link

commented Jul 17, 2019

Thanks @baywet this has been fixed

@estruyf estruyf added this to the 1.16.0 milestone Jul 17, 2019

@estruyf estruyf closed this in #192 Jul 17, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
2 participants
You can’t perform that action at this time.