Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update doxygen and add publish job to CI #293

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

justgook
Copy link
Contributor

@justgook justgook commented Aug 14, 2023

Add more modern ui for Oxygen, update it version, and add build job to publish it online after each successful commit - line in Demo

Copy link
Owner

@Stephane-D Stephane-D left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to use the current 'doc' folder as much as possible to setup these new doxygen template / job ? SGDK file structure contain more and more folders and I would rather prefer to limit it when possible :) Thanks !

@TeamCorgo
Copy link

TeamCorgo commented Jan 2, 2025

@justgook it's looking great! That said, I noticed a potential area where the effort has stalled, particularly with the maintenance of timestamp communications in the documentation.

It’s unfortunate to see that both the Doxygen version number and the deployment date have become outdated, especially considering they account for approximately ~30% of the files in the repository. To help streamline the process and ensure the documentation remains up to date, I have a few suggestions:

  1. Remove Doxygen and its produced documentation from the SGDK repo (delete the /doc directory).
  2. Create a separate SGDK Doxygen repository that pulls from the SGDK repo and automatically generates the documentation. Repository set to refresh every 24 hours.
  3. Publish the Doxygen documentation to a web location or GitHub Pages for easier access.
  4. Update the "INSTALLATION AND DOCUMENTATION" section in the readme.md to point to the new version of the documentation.

There are demo screenshots currently stored in /docs, which are referenced within readme.md. These images will need to be relocated to a new location but I do not have a recommendation.

If desired, I can get this drafted up and forked; I am shy and didn't want to trample through people's gardens without discussing first.

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.

3 participants