Skip to content

docs: Merge gh-pages commits into main #2546

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

Merged
merged 8 commits into from
Jul 11, 2025
Merged

Conversation

bog-walk
Copy link
Member

@bog-walk bog-walk commented Jul 8, 2025

Description

Summary of the change: Merge the 6 documentation commits made to gh-pages, which are missing on main.

Detailed description:

  • Why: Documentation website redirects and API docs have been updated and deployed from gh-pages since around 0.58.0. So these files on main have not been updated since then. Part of the release process involves calling dokkaGenerate on main, then copying-and-pasting a local copy of docs/api to gh-pages directly each time.

  • What:

    • Cherry-picked the 6 commits on gh-pages that diverged from main
    • Added an extra commit to sort out a file that wasn't properly deleted and a file that had not been updated on either branch since 0.59.0.

Type of Change

Please mark the relevant options with an "X":

  • Documentation sync

@bog-walk bog-walk mentioned this pull request Jul 8, 2025
1 task
@bog-walk bog-walk requested review from vnikolova and e5l July 8, 2025 01:09
@bog-walk
Copy link
Member Author

bog-walk commented Jul 8, 2025

@vnikolova Let me know if you think there'd be any issue with the html redirect files being moved to main. Or generally any issue with the gh-pages branch eventually being deleted.

@bog-walk
Copy link
Member Author

bog-walk commented Jul 8, 2025

@e5l I noticed when pushing directly to gh-pages, that the pages-build-deployment action was triggered automatically.

I'm assuming that, moving forward, we will want to only trigger this action manually with a release, not every time a commit is merged to main. If any changes need to be made here to enable/disable this action, feel free to push.

Copy link
Collaborator

@vnikolova vnikolova left a comment

Choose a reason for hiding this comment

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

@bog-walk The changes in the documentation-website folder need to be reverted to match what is on the main branch (cfg/buildprofiles.xml and hi.tree). These changes are not necessary anymore as GH pages should only use the static files from the docs folder.

@e5l
Copy link
Member

e5l commented Jul 8, 2025

@vnikolova we're going to drop gh-pages and use main as target documentation branch instead to simplify API docs publishing

@bog-walk bog-walk requested a review from vnikolova July 10, 2025 00:54
@bog-walk bog-walk force-pushed the bog-walk/merge-gh-pages-commits branch from 92ac81f to 130694b Compare July 10, 2025 23:11
Copy link
Collaborator

@vnikolova vnikolova left a comment

Choose a reason for hiding this comment

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

Looks good 👍

@bog-walk bog-walk merged commit fbd9a88 into main Jul 11, 2025
5 of 6 checks passed
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