Skip to content

fix(docs): repair broken links in English docs - #518

Merged
aymericzip merged 1 commit into
aymericzip:mainfrom
theluckystrike:fix/intlayer-docs-links
Oct 4, 2026
Merged

aymericzip merged 1 commit into
aymericzip:mainfrom
theluckystrike:fix/intlayer-docs-links

Conversation

@theluckystrike

Copy link
Copy Markdown
Contributor

Several English docs link to files that are not in the repo, so the links return 404 on GitHub. The translated docs are generated from the English ones, so each broken link also shows up in every locale.

Every old target below returns 404 at blob/main today and every new target returns 200. git cat-file -e origin/main:<path> gives the same result.

  • intlayer_with_fastify.md wraps the three package links in Google search URLs (https://www.google.com/search?q=%5B...). They now point straight to packages/{react,next,vite}-intlayer/exports.md.
  • packages/*/index.md does not exist for react-intlayer, next-intlayer, vite-intlayer, intlayer or intlayer-cli. Each package folder has exports.md. Fixed in the adonisjs, elysia, express, fastify and hono guides, how_works_intlayer.md and releases/v7.md.
  • dictionary/content_file.md links to translation_content.md, condition_content.md, enumeration_content.md, insertion_content.md, markdown_content.md, nested_content.md, file_content.md and plural.md. The files are translation.md, condition.md, enumeration.md, insertion.md, markdown.md, nesting.md, file.md and plurial.md.
  • content_file.md links to fill.md. The page is autoFill.md.
  • intlayer_with_nextjs_14.md, intlayer_with_nextjs_15.md and intlayer_with_nextjs_page_router.md link to intlayer_with_nextjs_no_locale_path.md, which was removed in b13cf18 when the Next.js docs were regrouped. They now link to intlayer_with_nextjs_16.md, which says at line 99 that both setups, with and without locale path routing, are covered there.
  • packages/react-intlayer/exports.md links t to docs/dictionary/translation.md, which is missing the docs/en part. The table columns were realigned by Prettier.
  • readme.md links to /blob/main/readme.md. GitHub paths are case sensitive and the file is README.md.

I bumped updatedAt in each changed doc, as docs/CLAUDE.md asks. Only the English sources are edited. The locales can pick the fixes up through the usual translation run.

Checks run on the 13 changed files: markdownFormatting and metadataValidity from docs/tools pass (12 of 12 files checked, readme.md is excluded by the tool's own pattern) and prettier --check passes with the repo config. After the change, no link in these files points to a path missing from main.

I wrote this with AI assistance and reviewed every changed line by hand.

Several English docs link to files that do not exist, and since the
translated docs are generated from them, every locale inherits the 404s.

- fastify guide: replace Google search wrapped URLs with direct links
- packages/*/index.md -> packages/*/exports.md
- dictionary/*_content.md, plural.md -> actual file names
- fill.md -> autoFill.md, readme.md -> README.md
- react-intlayer exports: docs/dictionary/translation.md -> docs/docs/en/dictionary/translation.md
- intlayer_with_nextjs_no_locale_path.md (removed) -> Next.js 16 guide,
  which covers the setup without locale path

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@aymericzip

Copy link
Copy Markdown
Owner

Hey @theluckystrike thanks! looks good to me, merging

@aymericzip
aymericzip merged commit ba964a1 into aymericzip:main Oct 4, 2026
1 check passed
@theluckystrike

Copy link
Copy Markdown
Contributor Author

Thanks, @aymericzip, for merging #518. The content type links in content_file.md now land on real pages like nesting.md and plurial.md instead of a 404, and every locale should pick that up on the next translation run.

My other work is at https://github.com/theluckystrike. Even a small one-time sponsorship through https://github.com/sponsors/theluckystrike would tell me the time on Intlayer's docs was valued, and I'd gladly keep sending fixes here. No pressure at all.

Thank you,
Michael Lip
Founder of https://zovo.one, 108 Chrome extensions with 150,000+ users
Also building https://makeroll.com and https://ml0x.com, open-source guardrails for Claude Code agents
Open source has to win, and small fixes like this one are my part of it

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