Skip to content

Conversation

@HeshamHM28
Copy link
Contributor

@HeshamHM28 HeshamHM28 commented Apr 7, 2025

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:

  • The documentation uses links like /getting-started/local-installation. This format works perfectly in Docusaurus, where links are resolved based on the site’s routing system.
  • However, this format breaks on GitHub. In GitHub, documentation files need to include the .md extension 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:

    If 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.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@HeshamHM28 HeshamHM28 changed the title Fix local setup path Fix local setup path in documentation Apr 7, 2025
@HeshamHM28 HeshamHM28 marked this pull request as draft April 7, 2025 13:20
@HeshamHM28 HeshamHM28 closed this Apr 7, 2025
@HeshamHM28
Copy link
Contributor Author

After careful consideration, I decided to close this PR without making the fix due to the following reasons:

  1. Docusaurus Link Structure: The link format used in the documentation (/getting-started/local-installation) is the standard structure recommended for Docusaurus. It works properly within the Docusaurus environment, and no issues exist there.

  2. GitHub Link Format Issue: Although this format doesn't work in GitHub, modifying all the documentation links would create inconsistencies between how the documentation behaves on GitHub and within Docusaurus.

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.

3 participants