Skip to content

fix/docs: fix spelling errors - #1855

Merged
marcleblanc2 merged 2 commits into
mainfrom
fix-documentation-typos
Sep 7, 2026
Merged

fix/docs: fix spelling errors#1855
marcleblanc2 merged 2 commits into
mainfrom
fix-documentation-typos

Conversation

@marcleblanc2

@marcleblanc2 marcleblanc2 commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Linear FE-499: Fix doc site issues

Summary

  • fix 43 misspelled terms across documentation, code examples, and redirect configuration
  • correct broken example values such as the autoindex image tag, executor placeholder, and codeintel database dump path
  • fix the permanent redirect property
  • rename PuginsIcon.tsx to PluginsIcon.tsx
  • leave generated changelog/observability content and intentional legacy tokens unchanged

Verification

  • targeted typo scan: all actionable terms removed
  • node dev/check-links.mjs: no dead links
  • Contentlayer generated 521 documents under Node 20
  • npx --yes node@20 node_modules/typescript/bin/tsc --noEmit: passed
  • git diff --check: passed

Prettier was not applied because the touched legacy docs are not currently Prettier-clean and formatting them would create unrelated churn.

@vercel

vercel Bot commented Sep 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sourcegraph-docs Ready Ready Preview Sep 7, 2026 1:35am UTC

Request Review

@marcleblanc2
marcleblanc2 requested a review from a team September 6, 2026 06:22
@marcleblanc2
marcleblanc2 enabled auto-merge (squash) September 6, 2026 06:22
@marcleblanc2 marcleblanc2 changed the title docs: fix spelling errors fix/docs: fix spelling errors Sep 6, 2026
@marcleblanc2
marcleblanc2 enabled auto-merge (squash) September 7, 2026 01:33
@marcleblanc2
marcleblanc2 merged commit 5c98c6f into main Sep 7, 2026
2 checks passed
@marcleblanc2
marcleblanc2 deleted the fix-documentation-typos branch September 7, 2026 01:35
marcleblanc2 added a commit that referenced this pull request Sep 8, 2026
Remove the 126 misspelled words from cspell-project-words.txt: the 112
words already listed in flagWords, plus 14 more found while reviewing the
dictionary (addresseses, Changs, certains, condeintel, ERRROS, gorelaser,
lobal, Redict, settingscasacde, sguqery, Sourcegraphs, Stablechore,
theyre, Wofli). The words that still appear in non-generated docs are
fixed in #1855 and #1873; the rest only occur in generated files that
cspell.json already ignores.

Keep eror, functio, and stabili in the dictionary and stop flagging them:
eror is Sourcegraph's log level token (lvl=eror), and functio and stabili
are truncation artifacts in verbatim command output, not misspellings.

Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-01a07e67-73b3-779f-8880-7ba770fe7ade
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