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

Convert absolute paths to relative paths in documentation #3067

Closed
1 of 5 tasks
bombard1004 opened this issue Aug 1, 2024 · 1 comment · May be fixed by #3068
Closed
1 of 5 tasks

Convert absolute paths to relative paths in documentation #3067

bombard1004 opened this issue Aug 1, 2024 · 1 comment · May be fixed by #3068

Comments

@bombard1004
Copy link

I'm submitting a...

  • Regression
  • Bug report
  • Feature request
  • Documentation issue or request (new chapter/page)
  • Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

Within the document, there are internal links using relative paths, while there are also internal links using absolute paths.

Expected behavior

Internal links within the document should use relative paths.

What is the motivation / use case for changing the behavior?

I believe that the absolute paths should be changed to relative paths for the following two reasons:

  1. Consistency
  2. When translating and distributing the document, there is an issue where the links in the translated document point back to the original English document. To resolve this, the translator would need to manually convert the links, but a better solution is to use relative paths.
@kamilmysliwiec
Copy link
Member

Let's track this here #3068

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 a pull request may close this issue.

2 participants