feat: add Spell checker using GitHub Actions

[mittalyashu]

Summary by CodeRabbit

• Chores

  • Added automated spell-checking that runs on pushes and pull requests, plus a new configuration to exclude generated and tooling files from checks.

• Bug Fixes

  • Fixed a spelling correction in the API reference (updated "REST-ful" to "REST-full").

[coderabbitai]

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7acecd8f-851b-4a80-b4ad-b039e1b529ae

📥 Commits

Reviewing files that changed from the base of the PR and between 981e7cb and 1bff51c.

📒 Files selected for processing (3)

• .config/spell-check.toml
• .github/workflows/spelling.yml
• content/api-reference/openapi.yaml

 _______________________________________
< `NaN` is not a valid user experience. >
 ---------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

_{✏️ Tip: You can disable in-progress messages and the fortune message in your review settings.}

Note

.coderabbit.yaml has unrecognized properties

CodeRabbit is using all valid settings from your configuration. Unrecognized properties (listed below) have been ignored and may indicate typos or deprecated fields that can be removed.

⚠️ Parsing warnings (1)

Validation error: Unrecognized key(s) in object: 'path_filters'

⚙️ Configuration instructions

• Please see the configuration documentation for more information.
• You can also validate your configuration using the online YAML validator.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

📝 Walkthrough

Walkthrough

The changes add spell-checking infrastructure (a spell-check config and a GitHub Actions workflow that runs typos on pushes and PRs) and correct a single documentation typo in the API reference.

Changes

Cohort / File(s)	Summary
Spell-check Configuration ​.config/spell-check.toml, .github/workflows/spelling.yml	Adds a .config/spell-check.toml with file exclusion patterns and a new GitHub Actions workflow (spelling.yml) that runs the crate-ci/typos spell-check action on pushes to main and on pull requests.
Documentation Fix content/api-reference/index.mdx	Typo correction: changed "REST-ful APIs" to "REST-full APIs".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding a spell checker workflow via GitHub Actions. It correctly reflects the primary focus of the pull request.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/gh-action-spellchecker

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

.config/spell-check.toml (1)

1-10: Consider adding an [default.extend-words] section for domain-specific terms.

Without an allow-list, the spell checker will flag valid technical terms (e.g., "RESTful"), leading to incorrect "fixes" like the one in this PR. Also consider excluding lock files.

+[default.extend-words]
+# Domain-specific terms
+RESTful = "RESTful"
+
 [files]
 extend-exclude = [
 	".next",
 	".idea",
 	".source",
 	"node_modules",
 	"cloudflare-env.d.ts",
 	# Biome config is schema defined
-	"biome.json"
+	"biome.json",
+	"pnpm-lock.yaml",
+	"package-lock.json"
 ]

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In @.config/spell-check.toml around lines 1 - 10, Add a spell-check allow-list
and exclude lockfiles: update the .config/spell-check.toml by adding a
[default.extend-words] section listing domain-specific terms (e.g., RESTful,
lancedb, Cloudflare, Biome, etc.) so the spell checker does not suggest
incorrect fixes, and extend the existing [files].extend-exclude array to include
common lock files (e.g., package-lock.json, yarn.lock, pnpm-lock.yaml) and any
other repo-specific artifacts; reference the existing [files] and extend-exclude
keys to locate where to add these entries.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/workflows/spelling.yml:
- Around line 6-11: The push trigger in the GitHub Actions workflow's "on: push"
block only lists "main", so the workflow never runs on the repository's default
branch; update the branches array under the "push" trigger to include "v0-2"
(i.e., add "v0-2" alongside "main" in the branches list) so spell checks run
when changes are pushed to the default branch.

In `@content/api-reference/index.mdx`:
- Line 15: The phrase "REST-full" in the content should be reverted to the
industry-standard "RESTful" and instead of modifying content to avoid future
spell-check flags, add "RESTful" (and variants if desired) to the spell-check
whitelist; update the spell-check config (the extend-words section in
.config/spell-check.toml) to include RESTful (and optionally REST-ful) and
revert the change in content/api-reference/index.mdx from "REST-full" back to
"RESTful" so the text is correct while the spell-check recognizes the term.

---

Nitpick comments:
In @.config/spell-check.toml:
- Around line 1-10: Add a spell-check allow-list and exclude lockfiles: update
the .config/spell-check.toml by adding a [default.extend-words] section listing
domain-specific terms (e.g., RESTful, lancedb, Cloudflare, Biome, etc.) so the
spell checker does not suggest incorrect fixes, and extend the existing
[files].extend-exclude array to include common lock files (e.g.,
package-lock.json, yarn.lock, pnpm-lock.yaml) and any other repo-specific
artifacts; reference the existing [files] and extend-exclude keys to locate
where to add these entries.

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

"REST-full" is incorrect — the standard term is "RESTful".

This change introduces a typo rather than fixing one. "RESTful" (from REST: Representational State Transfer) is the established industry term. "REST-full" is not a word.

Instead of changing the content, add RESTful (and variants like REST-ful) to an allowed-words list in the spell-check config so typos won't flag it. For example, in .config/spell-check.toml:

[default.extend-words]
# Industry-standard term
RESTful = "RESTful"

And revert this line:

-LogChimp uses REST-full APIs to build the backend on which it delivers content to the client side.
+LogChimp uses RESTful APIs to build the backend on which it delivers content to the client side.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@content/api-reference/index.mdx` at line 15, The phrase "REST-full" in the
content should be reverted to the industry-standard "RESTful" and instead of
modifying content to avoid future spell-check flags, add "RESTful" (and variants
if desired) to the spell-check whitelist; update the spell-check config (the
extend-words section in .config/spell-check.toml) to include RESTful (and
optionally REST-ful) and revert the change in content/api-reference/index.mdx
from "REST-full" back to "RESTful" so the text is correct while the spell-check
recognizes the term.

[mittalyashu]

Rebased the PR

[mittalyashu]

LGTM