Introduce codespell + fix configration.md filename typo (with redirect) - #8
Open
yarikoptic wants to merge 4 commits into
Open
Introduce codespell + fix configration.md filename typo (with redirect)#8yarikoptic wants to merge 4 commits into
yarikoptic wants to merge 4 commits into
Conversation
…s automagically
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
The prior codespell run (132e2e0) corrected `configration` -> `configuration` in link text within getting-started.md, pushover.md and telegram.md, but did not rename the actual file. With `onBrokenLinks: 'throw'` those links pointed at a non-existent page and the site failed to build. - git mv the file to the correctly-spelled name so internal links resolve. - Add @docusaurus/plugin-client-redirects and register a redirect from /getting-started/configration -> /getting-started/configuration so any external bookmarks / search-engine links to the old path keep working. Hash fragments (e.g. #pushover, #telegram used from the notifications pages) are preserved by the plugin's client-side redirect. Verified with `npm run build` (no broken links) and Playwright: - /getting-started/configration -> new URL, page renders - /getting-started/configration#pushover -> new URL + #pushover - Link click from /getting-started/ -> new URL - Article links on pushover.md / telegram.md -> new URL with anchor Co-Authored-By: Claude Code 2.1.251 / Claude Opus 4.7 <noreply@anthropic.com>
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.
Summary
Introduce codespell for spell-checking, fix the typos it caught, and — as a follow-up made necessary by one of those fixes — rename the misspelled
configration.mdfile and wire up a redirect so old URLs keep working.Initially got here by observing it in authelia docs to refer to a url with a typo.
Why the file rename is bundled here: codespell corrected the link text
configration→configurationingetting-started.md,pushover.mdandtelegram.md, but only text; the file itself remainedconfigration.md. WithonBrokenLinks: 'throw'those links then pointed at a non-existent page and the site would fail to build. Renaming the file and adding a client-side redirect makes the build green again and keeps external bookmarks / search-engine entries to the old URL working (including anchor fragments like#pushoverand#telegram).