Skip to content

Setup Doxygen#5

Open
ChristopherJTrent wants to merge 24 commits intoRaidcoreGG:mainfrom
ChristopherJTrent:main
Open

Setup Doxygen#5
ChristopherJTrent wants to merge 24 commits intoRaidcoreGG:mainfrom
ChristopherJTrent:main

Conversation

@ChristopherJTrent
Copy link
Collaborator

@ChristopherJTrent ChristopherJTrent commented Jan 31, 2026

This pull request includes a github workflow definition to automatically build documentation using doxygen and push it to a github pages site. It also includes the removal of old, unused code in v1/, and the addition of submodules for arcdps, mumble, and the core nexus API.
To serve this at docs.raidcore.gg per our discussion on discord, action will be required from Delta. For more info, please see https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain

EDIT to add: For a preview of the site, see http://christopher-trent.com/api-docs/

* add support for files in the ./pages directory

* add docs pages

* add a gitignore because I am nothing if not lazy.

* add bindings page

* add CONTRIBUTING

* Port the main section of AddonQuickstart

* add doxygen autorun

* add Keybinding guide

* use autolink instead of manual link

* update keybind tutorial name

* add note about further bindings

* tweak grammar in the preamble to the keybinds tutorial

* add events guide

* Open a bounty on targeted events

* update bounty page

* Update BOUNTIES.md

fix table formatting

* fix error in events page

* add resource sharing tutorial
@ChristopherJTrent
Copy link
Collaborator Author

We may have to rename this repo to RaidcoreGG.github.io to get the behavior we discussed. With that said, the functionality of this PR is effectively complete, and more docs can be added over time.

@ChristopherJTrent ChristopherJTrent marked this pull request as ready for review February 2, 2026 21:20
pin an ubuntu version in an attempt to fix the eternal wait for a hosted runner
Copy link
Member

@DeltaGW2 DeltaGW2 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 add the WebAPI as a listed project as well? I'd prefer having all documentation in one place, rather than focusing this generic documentation repo on just Nexus.

Also this is publishing the logo/favicon under an MIT license.

@ChristopherJTrent
Copy link
Collaborator Author

ChristopherJTrent commented Feb 4, 2026 via email

@ChristopherJTrent
Copy link
Collaborator Author

@DeltaGW2 Updated, this look better?

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