Fix local setup path in documentation #129
Closed
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.
PR Title: Fix Documentation Link Structure for Docusaurus and GitHub Compatibility
Description:
This PR addresses an issue with the current link structure in the documentation and ensures compatibility between GitHub and Docusaurus. The links currently follow the format
/getting-started/local-installation, which works for Docusaurus but does not work as expected on GitHub.Problem:
/getting-started/local-installation. This format works perfectly in Docusaurus, where links are resolved based on the site’s routing system..mdextension and follow the full folder structure (e.g.,/docs/docs/getting-started/local-installation.md).Example Issue:
The link in the documentation currently looks like this:
/getting-started/local-installationIf you click on the "Local Setup" link in the documentation, it will not work on GitHub because GitHub requires the
.mdand correct actual path file extension in the URL.