Overleaf-Workshop icon indicating copy to clipboard operation
Overleaf-Workshop copied to clipboard

[Feature Request] Improve documentation on how to enable spell checker

Open IgnacioHeredia opened this issue 8 months ago • 2 comments

Disclaimer

Please make sure all the items below is checked (i.e., prefixed with "- [x]")

  • [x] The request feature has not been addressed in the feature request list.
  • [x] The design of the feature does not require detailed discussion, or existing discussion with drawn conclusion can be found in Discussions Area at: [paste the link here]

Motivation

Please give strong enough reason(s) why the feature is demanded.

  • Adding this to the docs is fairly minimal and is a massive help

Feature Description

A clear and concise description of what you want to happen under what circumstance.

After Overleaf Website offloaded the spell checking to the frontend, this feature was no longer available in overleaf-workshop (issue). @iamhyc suggested opening a local replica and using local spell checker, but that would miss the benefits of using overleaf features (compile, PDF preview, etc).

It turns out that it's possible to use Code Spell Checker. You just have to enable the custom file scheme overleaf-workshop is using (detailed instructions)

    "cSpell.enabledSchemes": {
        "overleaf-workshop": true
    }

I think it would be nice to add these simple steps (or some kind of pointer) somewhere in the documentation (the README? the wiki?) because that would massively benefit users looking for this feature.

I can make a PR if needed.

IgnacioHeredia avatar Apr 26 '25 18:04 IgnacioHeredia

Thanks for the great work! Please feel free to open PR if you have time

QianrenLi avatar Apr 27 '25 02:04 QianrenLi

It's glad to know that code spell checker can support custom schemes!

@QianrenLi I see there is a update API on workspace configuration (link), please check if we can enable the configuration for "cSpell.enabledSchemes" by default.

iamhyc avatar Apr 27 '25 10:04 iamhyc