Skip to content

Automatic documentation publishing on GitHub Pages#115

Merged
dennis-zyska merged 7 commits intodevfrom
fix-114-documentation
Mar 9, 2026
Merged

Automatic documentation publishing on GitHub Pages#115
dennis-zyska merged 7 commits intodevfrom
fix-114-documentation

Conversation

@akash9676
Copy link
Collaborator

@akash9676 akash9676 commented Mar 9, 2026

Documentation is now automatically published to GitHub Pages for the main development branches, so docs stay updated without manual deployment.

New User Features

  • Public documentation link is updated in README.
  • Users can access branch-specific documentation paths for supported branches.

New Dev Features

  • Added automated docs deployment in CI.
  • Docs are published per branch path for dev and main.

Improvements

  • Documentation publishing is now simpler and more reliable.
  • Reduced manual deployment effort for docs updates.

Bug Fixes

  • NA

Known Limitations

  • Deployment works only for allowed branches (dev and main).

Future Steps

  • NA

branches:
- dev
- main
- fix-114-documentation
Copy link
Collaborator

Choose a reason for hiding this comment

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

that branch name should be removed before commit

deploy_docs:
runs-on: ubuntu-latest
needs: build
if: (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/fix-114-documentation') && github.event_name == 'push'
Copy link
Collaborator

Choose a reason for hiding this comment

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

as discussed in Elements, we should not overwrite the main documentation with the dev branch, therefore it make sense to split the documentation under two different paths

@akash9676 akash9676 requested a review from dennis-zyska March 9, 2026 15:27
@dennis-zyska dennis-zyska merged commit c316c05 into dev Mar 9, 2026
3 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.

2 participants