docs: rename Proofing to Spell check (SD-2895)#3059
Merged
Conversation
Both shipped provider examples advertise ["spelling"] capabilities only and filter responses to kind: 'spelling' before returning. The v1 UI renders only spelling underlines (the proofing.css file's own comments call grammar and style 'future, stored but not rendered'). Calling the feature 'Proofing' in customer copy oversells what ships. This is a docs terminology change only. The public config remains proofing; the visible product feature is now documented as Spell check. Visible labels renamed: - Sidebar group Proofing -> Spell check - Page title Spell Check & Proofing -> Spell check - Custom proofing provider -> Custom spell-check provider - Built-in UI overview card Proofing -> Spell check - Context menu doc 'Proofing items' -> 'Spell-check items' - Accessibility note 'proofing in web layout' -> 'spell check in web layout' - Configuration page section heading Proofing -> Spell check Folder renames (with redirects so old links keep working): - apps/docs/editor/proofing -> apps/docs/editor/spell-check - examples/editor/proofing -> examples/editor/spell-check Kept as-is (real API surface): - proofing config key - ProofingProvider / ProofingConfig / ProofingIssue / etc. type names - proofing.enabled / proofing.provider / proofing.ignoredWords params - onProofingError callback name Page rewrites lead with mechanism (extract -> map -> render -> right-click) per brand voice rule 11. Honest scope-of-v1 callout names what's not shipped (grammar, style, headers/footers) per brand rule 8.
Contributor
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4ca9fa0c36
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Address review feedback on PR #3059. The original commit overreached by renaming the examples folder along with the docs folder. Examples folders are internal codebase paths, not user-facing surface; renaming them touches CI, package.json names, and external-facing GitHub URLs without customer benefit. Reverts: - examples/editor/spell-check back to examples/editor/proofing. Internal folder name stays as it was; only the docs surface is renamed for customer-facing language. - Doc cross-references to GitHub example folders updated back to /examples/editor/proofing/ paths. Fixes review findings: - Two pre-existing redirects in docs.json had destinations pointing at /editor/proofing/* (now redirected onward to /editor/spell-check/*). Updated /guides/general/proofing and /guides/general/custom-proofing- provider to point at the final /editor/spell-check/* destinations directly. Avoids redirect chains per the team's no-chains rule established on PR #3054. - examples/README.md still had a Proofing section heading + GitHub link to ./editor/proofing (the link is fine after this commit since the folder is back at proofing/, but the section heading should reflect the user-facing name). Renamed heading to Spell check; link target stays at ./editor/proofing. - Two semicolons in apps/docs/editor/superdoc/configuration.mdx introduced by the rename. Brand voice rule: 'if there's a semicolon, definitely split it.' Both split into two sentences.
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
2 participants
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.
Both shipped provider examples (Typo.js, LanguageTool) advertise
["spelling"]capabilities only and filter responses tokind: 'spelling'before returning. The v1 UI renders only spelling underlines (theproofing.cssfile's own comments call grammar and style "future, stored but not rendered"). Calling the feature "Proofing" in customer copy oversells what ships today.This is a docs terminology change only. The public config remains
proofing; the visible product feature is now documented as Spell check.Visible labels renamed:
Proofing→Spell checkSpell Check & Proofing→Spell checkCustom proofing provider→Custom spell-check providerFolder renames (with redirects so old links keep working):
apps/docs/editor/proofing/→apps/docs/editor/spell-check/examples/editor/proofing/→examples/editor/spell-check/Kept as-is (real API surface):
proofingconfig key,proofing.enabled,proofing.provider,proofing.ignoredWords,onProofingErrorProofingProvider,ProofingConfig,ProofingIssue,ProofingIssueKind, etc. type namesThe custom-provider page has an explicit note: the TypeScript types use
Proofing*because the contract is broader than spelling; v1 UI renderskind: 'spelling'only. The configuration page mirrors this on the section heading.Page rewrites lead with mechanism (extract → map → render → right-click) per brand voice rule 11. Honest scope-of-v1 callout names what's not shipped (grammar, style, headers/footers) per brand rule 8.
Verified:
pnpm validate(mintlify),pnpm check:em-dashes,pnpm check:icons,pnpm check:imports,bun scripts/validate-examples-demos.tsall green.