Add working example to custom check documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 234
- Forks
- 92
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 6
Description
I've been trying to add some custom checks to my theme, but I could not make it work. I found different issues while trying to make this work, mainly because how the file is being loaded.
Currently the documentation on custom checks is pretty minimal, and point to the existing checks to get ideas, but as far as I could test the syntax used is not exactly the same.
I think that a small working example, would be of great help, and it would be even better if you provide examples both in typescript and plain javascript just in case.
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 the linked custom checks documentation and review how existing checks are referenced there. Add small working examples showing custom-check syntax and file loading in both TypeScript and plain JavaScript; it is done when the documentation makes these workflows reproducible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100