Proposal: Automating Documentation Publishing w/ GitHub Actions

[riccardoaran]

Hi everyone,

I’d like to propose an enhancement to our documentation publishing workflow using GitHub Actions.

The main goal is to keep our documentation repository clean and focused solely on the Markdown files, while ensuring that any updates to the documentation automatically trigger an update to our site.

This approach works seamlessly with various static site generators, whether we decide to use MkDocs, VuePress or any other tool. By leveraging GitHub Actions, we can automatically rebuild and deploy the site with GitHub Pages every time a change is made. This means that contributors can simply make modifications to the Markdown files, and once their pull request is merged, the site will automatically update to reflect those changes.

If anyone has experience with this type of setup, I’d appreciate your input!

Thanks 🙏

[bitsalv]

Hi @riccardoaran,

Great proposal! I've implemented exactly what you described.

Documentation Repository: edge-mining/docs#6 - Clean Markdown-only structure with automated sync

Website Repository: #3 - VuePress website with automated deployment

The workflow provides clean separation between content (docs repo) and website (this repo) with full GitHub Actions automation, exactly as you proposed.

Ready for review! 👍