Skip to content

Conversation

anniemandal24
Copy link

** 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 (/docs folder) and publishing them with GitHub Pages, we gain:

  • Easier collaboration (contributors can improve docs with PRs).
  • Automatic publishing on changes, no manual steps required.
  • Ability to serve diagrams (SVGs) and Markdown directly.

** How It Works

  • Workflow triggers on changes to the docs/ folder in the main branch.
  • It clones the jpf-core.github.io repo.
  • Copies all content from jpf-core/docs into it.
  • Commits and pushes changes.
  • Published site will be available at: https://jpf-core.github.io/

** Required Maintainer Setup

  • Create a repository named jpf-core.github.io (if it does not exist yet).
  • Add a GitHub Actions secret named GH_PAGES_TOKEN with a Personal Access Token that has repo scope.

** Next Steps
Once merged, any changes to docs/ in jpf-core will automatically appear at the GitHub Pages site.

@cyrille-artho
Copy link
Member

Thank you for this PR.
As of now, we only have graphics in docs, so the workflow would not find any documentation to mirror.
For this to work, we have to migrate the content from the wiki to docs. However, the syntax of GitHub pages is slightly different from the wiki syntax in a few ways, so this would have to be fixed.
Have you looked into this? If you have made changes to docs, please add these files to the PR, too.
Also, if you can (for now) set up a different target to try this, please share the URL of the result so we can take a look.

@anniemandal24
Copy link
Author

@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.
Thank you for reviewing!
url - https://anniemandal24.github.io/jpf-core/

@cyrille-artho
Copy link
Member

Thanks for sharing that version.
The current page describes the process of pushing changes to the documentation.
However, we also have to convert the documentation itself. This brings with it a number of steps:

  1. The wiki content needs to be copied to docs.
  2. The wiki syntax needs to be adapted to the GitHub pages syntax in cases where they differ.
  3. Some paths may require changes, e.g., paths to images.

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.

@anniemandal24
Copy link
Author

@cyrille-artho I made the required changes please take a look at the updated url: https://anniemandal24.github.io/jpf-core/
I suggest reviewing a few of the migrated pages to confirm formatting and link behavior.

Once we validate the approach, I can systematically update the rest of the documentation for links, image paths, and syntax differences.

@cyrille-artho
Copy link
Member

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.
I'll look at your PR for the publishing part; publishing to github.io is still something that we need to set up.
Finally, there is the question of cleaning up outdated information, such as some contact e-mail addresses that we no longer use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants