ci: fix docs preview link for relative frontmatter slugs#2836
Open
ci: fix docs preview link for relative frontmatter slugs#2836
Conversation
Docusaurus resolves relative slugs (no leading /) from the file's directory. e.g. `slug: installation` in getting-started/installation.md becomes /getting-started/installation, not /installation. The preview link script was prepending / directly, producing the wrong URL for files with relative slugs. Caught on #2827.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Fixes incorrect preview links for docs files that use a relative
slugin their frontmatter.Docusaurus resolves relative slugs (no leading
/) from the file's directory. For example,slug: installationinsite/docs/getting-started/installation.mdproduces the URL/getting-started/installation— not/installation.The preview link script was prepending
/directly, producing the wrong URL. Caught on #2827.Fix: when the slug doesn't start with
/, construct the full path using the file's directory.Test plan
/, no slug) — all resolve correctlygetting-started/installation.mdwithslug: installation→/getting-started/installation✓slug: /) → unchanged ✓