Skip to content

fix(docs): use file-relative .md/.mdx links to prevent URL resolution bugs#106

Open
lennardrother wants to merge 1 commit into
openmcp-project:mainfrom
lennardrother:main
Open

fix(docs): use file-relative .md/.mdx links to prevent URL resolution bugs#106
lennardrother wants to merge 1 commit into
openmcp-project:mainfrom
lennardrother:main

Conversation

@lennardrother
Copy link
Copy Markdown
Contributor

What this PR does / why we need it:

Fixes broken links by replacing them with releative links with .md/.mdx extension.

The following links were fixed:

Example:

Screen.Recording.2026-05-22.at.11.54.39.mov

Which issue(s) this PR fixes:
NONE

Special notes for your reviewer:

Release note:

Fixed broken links by replacing them with releative links with .md/.mdx extension

… bugs

Signed-off-by: Lennard Rother <l.rother@sap.com>
Copy link
Copy Markdown
Member

@maximiliantech maximiliantech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @lennardrother, thanks for testing this 🥇 I am a bit unsure if we are really solving the URL resolution bugs here. What I do see is that we still have a lot of different file extensions. Some of them being .md and some of them being .mdx. I remember that we have looked into this whole URL resolution and page referencing problem before and we came to the conclusion that we simply use the id field in the header of every file. Shouldn't we use this instead of the file extensions? What do you think?

@lennardrother
Copy link
Copy Markdown
Contributor Author

Hi, if I understand correctly setting id doesn't solve the issue.

According to the docs there are two ways of linking: through a URL path (without file extension) or a file path (with file extension). URL paths are resolved according to the page's URL location. This means this link without file extension is rendered as <a href="/users/getting-started/getting-started/onboard">Onboarding</a>, which does not exist. The file lives in users/getting-started and has the id onboard so it is available at /users/getting-started/onboard.

I assume we wanted to link using file path but forgot the extension so Docusaurus uses the URL path.

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.

2 participants