Skip to content

feat: add Spell checker using GitHub Actions #470

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mittalyashu wants to merge 2 commits into
base: v0-2
Choose a base branch
from
Open

feat: add Spell checker using GitHub Actions #470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b35c20
feat: add spell checker GitHub Action
mittalyashu Feb 17, 2026
2ef1c16
fix: typos
mittalyashu Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .config/spell-check.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[files]
extend-exclude = [
".next",
".idea",
".source",
"node_modules",
"cloudflare-env.d.ts",
# Biome config is schema defined
"biome.json"
]
25 changes: 25 additions & 0 deletions .github/workflows/spelling.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: spelling

permissions:
contents: read

on:
push:
branches:
- main
pull_request:

Comment on lines +6 to +11
Copy link

@coderabbitai coderabbitai bot Feb 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check the default branch of the repository
git remote show origin 2>/dev/null | grep "HEAD branch" || echo "Could not determine default branch"
# Also check what branches exist
git branch -r | head -20

Repository: logchimp/docs

Length of output: 119

Add v0-2 to the push trigger — the workflow doesn't run on the default branch.

The workflow only triggers on pushes to main, but v0-2 is the repository's default branch. Spell checks won't run when changes are pushed to the primary development branch. Update the workflow to include v0-2:

Suggested fix 
 on:
   push:
     branches:
       - main
+      - v0-2
   pull_request:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
on:
push:
branches:
- main
pull_request:
on:
push:
branches:
- main
- v0-2
pull_request:
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/spelling.yml around lines 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.

env:
CLICOLOR: 1

jobs:
spelling:
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- name: Checkout Actions Repository
uses: actions/checkout@v4
- name: Spell Check Repo
uses: crate-ci/typos@v1.34.0
with:
config: ./.config/spell-check.toml
2 changes: 1 addition & 1 deletion content/api-reference/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Welcome to the LogChimp API Reference.

If you’re new to LogChimp, start with the [Guide](/guide), then come back here for details on specific endpoints.

LogChimp uses REST-ful APIs to build the backend on which it delivers content to the client side.
LogChimp uses REST-full APIs to build the backend on which it delivers content to the client side.
Copy link

@coderabbitai coderabbitai bot Feb 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ 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.


## Path & Version

Expand Down
Loading