cheminfo / cheminfo/eln-docs

re-enable spellcheck, or at least have a linter

Open
#68 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
3
Forks
14
Avg merge
1h 20m
Merged PRs (30d)
1

Description

I think it'd be great to remove typos in the docs. For this, we introduced the action (which is manually disabled at the moment).

We can

- make the action more useful by whitelisting more chemistry vocabs to the whitelist
- ask contributors to run a linter/install some spellchecking extension

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the manually disabled spellcheck action and reviewing how its whitelist is configured. Decide whether to make the action useful with additional chemistry vocabulary or document a contributor linter/spellchecking workflow; done means the chosen approach is available for contributors and catches documentation typos.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
documentation, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.