Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 ofhttps://libmodbus.org/reference/modbus_tcp_listen
. This doesn't cause an issue on the index page as the current URL ishttps://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