Documentation and changes to filenaming conventions and Docker image

[jonasbn]

This is quite the mouthful and I have plenty of ideas on further documentation improvements, but before I do even more, I wanted to hear you, if these efforts and contributions would be of interest.

The whole PR is based on a blog post I wrote about your magnificent GitHub Action.

I struggled quite a bit with your GitHub Action and learned a lot along the way and this was documented in the blog post and then distilled into this documentation/feature contribution.

1. The Dockerfile holds changes so local development is easier
2. The default configuration files have been renamed for a less intrusive use-case scenario
3. The documentation describes some of all the things I ran into, both with the action and my own changes

I would love to contribute more and would prefer to send contributions upstream, let me know what you think, pick what you can use, ask me questions, request changes - no hard feelings

For future possible contributions, I picture improvements in:

• Toolchain documentation (how to work with spelling, aspell/ hunspell, the action etc)
• Improved and more extensive feature description

Looking forward to hearing from you,

jonasbn

[jonasbn]

Hi @rojopolis

I am pondering forking your repository and publishing an alternative action, but I would prefer to send changes upstream to your project.

Please let me know your stance on this?

If you need a temporary co-maintainer or contributor I am up for it.

[rojopolis]

Hi @rojopolis

I am pondering forking your repository and publishing an alternative action, but I would prefer to send changes upstream to your project.

Please let me know your stance on this?

If you need a temporary co-maintainer or contributor I am up for it.

Hi @jonasbn,

You're more than welcome to fork the project, or I can add you as a maintainer. As you may have noticed I don't really have the cycles to maintain this project. I developed this as a quick example of using GitHub actions for a book project that was cancelled. I don't currently use it myself. Let me know if you'd like to be added.

[jonasbn]

Hi @rojopolis

I would very much like to contribute to your repository. I am using your action and I would very much like to help maintain the GitHub action, since I find it very useful.