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

Fix doc links #653

Merged
merged 1 commit into from Oct 3, 2022
Merged

Fix doc links #653

merged 1 commit into from Oct 3, 2022

Conversation

jordanjohnson56
Copy link
Contributor

Issue

Documentation links on pages other than index.md point to non-existent paths, returning a 404 error when trying to navigate between pages via the on-page links. The sidebar links work fine, as do links on the homepage.

Cause

The links in the documentation markdown are written without file extensions, so mkdocs appends them as sub paths of the current URL, e.g. https://libmodbus.org/reference/modbus_new_tcp/modbus_tcp_listen (does not exist) instead of https://libmodbus.org/reference/modbus_tcp_listen. This doesn't cause an issue on the index page as the current URL is https://libmodbus.org/reference, therefore appending the sub path creates a valid link.

Fix

Adding file extensions to the markdown links causes mkdocs to create valid links.

Changes

  • .md was added to the documentation links so mkdocs produces the correct links
  • Fixed a typo for one of the links in index.md

@cla-bot
Copy link

cla-bot bot commented Sep 4, 2022

We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please fill https://forms.gle/5635zjphDo5JEJQSA to get added. Your document will be manually checked by the maintainer. Be patient...

@jordanjohnson56
Copy link
Contributor Author

I believe I filled out the CLA. Let me know if I need to fill it out again.

@stephane stephane merged commit 54c0923 into stephane:master Oct 3, 2022
@stephane
Copy link
Owner

stephane commented Oct 3, 2022

Good catch. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants