Add GitHub Pages workflow to publish documentation#560
Conversation
|
Thank you for this PR. |
|
@cyrille-artho I have migrated the content from the GitHub Wiki into the docs/ folder and set up a GitHub Actions workflow that automatically deploys these docs to GitHub Pages. The workflow will: Build and publish the docs/ folder into a gh-pages branch. Keep the site updated on every push to main. Could you please: Check that the workflow runs successfully on your side. Confirm that the gh-pages branch is created and enable it in Settings → Pages (source: gh-pages / root). Let me know if any adjustments are needed in the configuration. |
|
Thanks for sharing that version.
Have you tried to do step 1 or a part of it? If we have a number of examples, we can see how much of the content "breaks" in terms of syntax or paths that need updating. |
|
@cyrille-artho I made the required changes please take a look at the updated url: https://anniemandal24.github.io/jpf-core/ Once we validate the approach, I can systematically update the rest of the documentation for links, image paths, and syntax differences. |
|
Thank you for your work. It looks like Mahmoud has in the meantime found a way to make the links work, so we will soon have a version where the syntax and links are fixed for the new platform. |
** Overview
This PR introduces a GitHub Actions workflow that automatically publishes the contents of the
docs/folder to GitHub Pages (jpf-core.github.io).** Motivation
Currently, documentation is stored in the GitHub Wiki, which does not allow contributions via pull requests. By moving docs into the main repo (
/docsfolder) and publishing them with GitHub Pages, we gain:** How It Works
docs/folder in themainbranch.jpf-core.github.iorepo.jpf-core/docsinto it.** Required Maintainer Setup
jpf-core.github.io(if it does not exist yet).GH_PAGES_TOKENwith a Personal Access Token that hasreposcope.** Next Steps
Once merged, any changes to
docs/injpf-corewill automatically appear at the GitHub Pages site.