fix(docs): broken numeric-prefix links in Client + Connector#6
Open
fix(docs): broken numeric-prefix links in Client + Connector#6
Conversation
Three intra-doc links pointed at the literal numeric-prefixed
filename (e.g. `./02-installation`) but Docusaurus auto-strips
the `0X-` prefix from the URL slug at build time, so the
published URLs are `/Client/installation`, `/Client/intro`, etc.
The literal-prefix links 404'd in production.
Fixed by appending `.md` to each link target. Docusaurus resolves
`.md` links through its file → slug graph regardless of prefix-
stripping, so the links survive future renames and slug-config
changes.
- docs/Client/01-intro.md:27 — `./02-installation` → `./02-installation.md`
Plus an adjacent `./integration-prompt` → `./integration-prompt.md`
for consistency.
- docs/Client/integration-prompt.md:17 — four sibling refs:
`./02-installation`, `./namespacing/strauss`,
`./configuration`, `./namespacing/merging-into-existing-composer`
all gained `.md`.
- docs/Connector/help-scout.md:29 — `../01-intro` was doubly
wrong: the path went up one level (to `docs/`) where no
`01-intro` exists, AND was missing the extension. Fixed to
`./01-intro.md`, which resolves to `docs/Connector/01-intro.md`
— the Connector intro page the surrounding copy actually
refers to.
Reported via the broken
docs.trustedlogin.com/Client/02-installation link surfaced from
the Client SDK intro page.
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
1 participant
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.
Reported via the broken
docs.trustedlogin.com/Client/02-installationlink from the Client SDK intro page.Root cause
Three intra-doc links pointed at the literal numeric-prefixed filename (e.g.
./02-installation) but Docusaurus auto-strips the0X-prefix from the URL slug at build time. Published URLs are/Client/installation,/Client/intro, etc. — the literal-prefix references 404 in production.Fix
Appended
.mdto each link target. Docusaurus resolves.mdlinks through its file → slug graph regardless of prefix-stripping, so the links survive future renames and slug-config changes.docs/Client/01-intro.md:27./02-installation./02-installation.mddocs/Client/01-intro.md:28./integration-prompt./integration-prompt.md(consistency)docs/Client/integration-prompt.md:17.md.mddocs/Connector/help-scout.md:29../01-intro./01-intro.mdThe Connector help-scout one was doubly wrong:
../went up todocs/where no01-introlives, AND was missing the extension. Fixed to./01-intro.md(same dir) so it resolves to the Connector intro the surrounding copy actually refers to.Test plan
/Client/intro, click "Installation guide" → lands on/Client/installation/Connector/help-scout, click "do that first!" → lands on/Connector/intro