Automatic Wiki on github

[JesseSwildens]

Is your feature request related to a problem? Please describe. Automatic wiki

Describe the solution you'd like Automatic wiki

Additional context Add any other context or screenshots about the feature request here.

[tomseli]

Moved back to todo to wait for #5

[tomseli]

Suggested solution: Using github pages we can deploy the doxygen artifacts on main push. The doxygen build files can either be stored on a separate repo or as a branch in the current repo.

If a separate repo is used the link will be: username.github.io If the current repo is used the link should be: username.github.io/repository-name (I think)

For the current repo would be:

• Set up a workflow using: https://github.com/marketplace/actions/doxygen-github-pages-deploy-action

For separate repo I assume it would be:

• For the new repo:
  • Set up a workflow using: https://github.com/marketplace/actions/doxygen-github-pages-deploy-action
• Current repo would need a workflow:
  • Clone the new repo
  • Unzip the doxygen build artifacts
  • Push the artifacts to the new repo. This will trigger it to rebuild te page.

N.B. I was unable to find a way to attach the github page to the navigation bar. A hyperlink in the readme will have to do.

Example: https://github.com/tomseli/tomseli.github.io/tree/main https://tomseli.github.io/

@JesseSwildens Could you review this?

[JesseSwildens]

That would be possible, but would this require the repo to be public to take effect @tomseli? Public is fine but I would like to keep this a private repo if possible.

[tomseli]

Since this repo is on a PRO plan, the repo should be able to stay private, with the doxygen page public.

[JesseSwildens]

Is now live at: https://jesseswildens.github.io/Software-ontwikkeling-VESOFTON/

For this page to be private as well it requires a Github enterprise license which is beyond what is necessary so this is unfortunately public.