Skip to content

fix: correct broken emoji-key docs link (404) in generated content - #538

Open
MBK-fr wants to merge 1 commit into
all-contributors:mainfrom
MBK-fr:fix/allcontributors-emoji-key-404
Open

MBK-fr wants to merge 1 commit into
all-contributors:mainfrom
MBK-fr:fix/allcontributors-emoji-key-404

Conversation

@MBK-fr

@MBK-fr MBK-fr commented Sep 20, 2026

Copy link
Copy Markdown

Problem

The "emoji key" link that the CLI writes into the contributors section of every README points to:

https://allcontributors.org/docs/en/emoji-key

That URL now returns 404 — the docs site was reorganised and the page moved to:

https://allcontributors.org/en/reference/emoji-key/

You can confirm: the old path returns 404 while the new one returns 200. Because this string is emitted by all-contributors init, the dead link has propagated into a very large number of downstream project READMEs.

Fix

Point the generated link at the live page. Changed:

  • src/init/init-content.js — the source string used for new projects
  • README.md — this repo's own contributors section
  • src/init/__tests__/__snapshots__/init-content.js.snap and add-contributors-list.js.snap — the snapshots that assert the generated content

No behavioural change other than the corrected URL.

Verification

  • Old URL …/docs/en/emoji-key → 404; new URL …/en/reference/emoji-key/ → 200.
  • Full test suite green: vitest run → 15 files, 114 tests passed (snapshots updated to match the corrected source).
  • eslint --fix + prettier --write (lint-staged pre-commit) pass.

The 'emoji key' link the CLI writes into every README's contributors
section points at https://allcontributors.org/docs/en/emoji-key, which
now returns 404. The page moved to
https://allcontributors.org/en/reference/emoji-key/.

Update the source string in src/init/init-content.js, the README, and
the matching init/add snapshots so newly initialised projects link to
the live page. Byte-for-byte identical otherwise; full vitest suite
passes (114 tests).
@matbrgz

matbrgz commented Sep 27, 2026

Copy link
Copy Markdown

Review from Matheus Breguêz (@matbrgz):

Essential fix, @MBK-fr!

Updating the legacy /docs/en/emoji-key path to the canonical /en/reference/emoji-key/ page fixes the 404 in newly generated tables across downstream projects. Test snapshots and linting are all passing cleanly.

This branch has not been deployed

No deployments
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