jackfirth / jackfirth/resyntax
Scribble lint for common typos in docs
Open
Nobody has claimed this yet.
new lint
- Dominant language
- Racket
- Stars
- 70
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
If I can get Resyntax to run on non-Racket files, then a great refactoring rule to have would be one that corrects common typos in Scribble documentation.
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 by examining how Resyntax currently handles Racket files and whether its engine can process non-Racket files. Then investigate Scribble documentation inputs and define the scope of the common-typo rule. Done means a documented rule can analyze Scribble files and correct the agreed typo cases.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100