Skip to content

Commit 4972bef

Browse files
authored
Add todo to consider replacement of spellchecker
Make it clear that the spellchecker is optional, to reduce a barrier to contributors.
1 parent 1489c3a commit 4972bef

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/contributing/setup-build.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,12 @@ This document covers how to build the Plone Documentation and check it for quali
1818

1919
## Installation
2020

21-
Install [Enchant](https://abiword.github.io/enchant/) to check spelling.
21+
Optionally install [Enchant](https://abiword.github.io/enchant/) to check spelling.
22+
23+
```{todo}
24+
Due to the complexity of installing Enchant and the inability of its Python bindings in [pyenchant to properly spellcheck hyphenated words](https://github.com/pyenchant/pyenchant/issues/286) through the Sphinx extension [`sphinxcontrib-spelling`](https://github.com/sphinx-contrib/spelling), the [Plone Documentation Team](https://github.com/orgs/plone/teams/documentation-team/members) is [evaluating Vale as a replacement](https://github.com/plone/documentation/issues/1347).
25+
```
26+
2227

2328
**macOS**
2429

0 commit comments

Comments
 (0)