search

apainintheneck / crystal-linenoise

Crystal bindings for the Linenoise library
https://apainintheneck.github.io/crystal-linenoise/
MIT License
1 stars 0 forks source link

Add docs to Github Pages #8

Closed apainintheneck closed 8 months ago

apainintheneck commented 8 months ago

These can be generated by running crystal docs but as a user I'd usually like to see this sorts of stuff online or in the repo itself before I have to download and run any code.

The key here will be to add a check on CI for outdated docs.

apainintheneck commented 8 months ago

It looks like the site cannot be checked to see if it's outdated on CI because it contains the commit hash which will always be different from when it was generated. Maybe it'd be a good idea to just create a Github Action for this to run crystal docs and then just deploy that site automatically every time there is a push to the main branch. It'd still require some manual setup though.

apainintheneck commented 8 months ago

Closed by #11