spellcheck-github-actions VS zeal

Docker image updated to Python 3.12.1 slim via PR #177 from Dependabot. Release notes for Python 3.12.1

Today I have released version 0.35.0 of the GitHub Action for doing spelling checking of your documentation etc. for which I am the current maintainer.

GitHub Actions are convenience for packaging tooling for execution on the GitHub platform or using a local runner etc. As you can see on the GitHub Marketplace this mean that a lot of actions are wrapping of common and useful tools to adapt to the GitHub toolbox and toolchain. The same goes for GitHub Spellcheck Actions, it is an implementation based on PySpelling a nifty tool to do spelling checks on Python, Markdown, Text files etc.

The release is just a maintenance release with no significant changes, one could ask why I would even write about a maintenance release and I can see that I did not write about when I released 0.28.0, which was also just a maintenance release.

Finally I got around to pushing release 0.27.0 of the GitHub Spellcheck Action, it has been in my TODO pipeline for way too long.

The 0.15.0 and 0.16.0 versions are announced to be sunsetted.

lxml requirement bumped from version 4.6.5 to 4.9.1 addressing a security issue SNYK-PYTHON-LXML-2940874 / CVE-2022-2309 / CWE-476 via PR #104 from @snyk-bot

Feedback and questions about this new feature is of course welcome, here as well as in the Discussions section in the GitHub repository.

I am the current maintainer of a GitHub Action for checking spelling in files in a GitHub repository. The action "GitHub Spellcheck Action" (rojopolis/spellcheck-github-actions) has grown in popularity and is used in several GitHub repositories, meaning that changes to the software and it's availability has become significant factors in it's life cycle. At the same time, it is based on open and free infrastructure and maintenance, so I decided it was time to introduce a sunset policy.

Addressing issue #84 via PR #90 from @jonasbn. With the introduction of use of optional quotes, do note the limitations outlined in the documentation - thanks to @xsaero00 for the bug report

There's also Zeal (https://zealdocs.org/) which is basically the same as Dash but open source and runs on non-Mac devices.

For offline tech documentation you can use Zeal. Must have tool for poor internet connection places. Present in ubuntu repos. https://zealdocs.org/

ads don't have to proprietary

here's one example of ads in FOSS https://github.com/zealdocs/zeal/issues/779

There’s stuff like https://zealdocs.org/ that allow you to take all relevant documentation with you so offline coding will work.

If you just want to be productive, you could also bring a lot of books or downloaded tutorials on a drive.

Btw, make sure your drive is encrypted and you think of a way to backup your data so you don’t lose the offline progress.

I’d suggest you look into Kiwix¹ and also Zeal².

1. https://www.kiwix.org/

2. https://zealdocs.org/

For offline documentation, I use Zeal (called Dash on macos) which looks/works almost identically to rubydoc.info but much faster since it's offline, has a standard interface for all installed language documentations, and only 1 global hotkey away while programming.

I highly recommend using local solutions to this local issue: Zeal[1] (aka Dash[2] on MacOS)

Load up the "docsets" of your languages (lightly edited HTML docs for indexing purposes) and use a global keyboard shortcut (F8 for me) to pull up Python/Postgres/Terraform docs, searching for the right function without internet query.

This isn't straight up applicable to all questions of course, but "How do I search regular expressions in Python again?" is now as easy as "re"

Note that the docsets can be converted from normal HTML ones via doc2dash[3], especially useful to load up custom docs like private providers.

[1]: https://zealdocs.org/