CI: spell-check the course content
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 1
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 7
Description
Spell-check the course content.
The course is mostly prose, and prose is what readers judge. A typo in a tutorial undermines it more than in application code.
Scope
cspell (or equivalent) over content/**/*.md and the README.
The actual work is the dictionary
A stock dictionary will flag hundreds of legitimate terms and become noise that everyone ignores — occ, ExApp, AppAPI, Nextcloud, Vite, nvm, Codespaces, QBMapper, apps-extra, SQLAlchemy, FastAPI, Psalm, and so on. Budget the effort for building a project dictionary, not for wiring up the action.
Consider limiting it to prose and excluding fenced code blocks, since code identifiers are the main source of false positives.
Done when
It runs on PRs and its output is trustworthy enough that a failure means something.
Part of #38.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with content/**/*.md and the README, then inspect the repository's existing CI configuration to see how checks run on PRs. Evaluate cspell or an equivalent against prose while considering fenced-code exclusions, and build a project dictionary for terms such as Nextcloud, Vite, and SQLAlchemy. Done means PR spell-checking runs and failures are trustworthy.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100