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

docs: initialize docusaurus #66

Merged
merged 5 commits into from
May 29, 2024
Merged

docs: initialize docusaurus #66

merged 5 commits into from
May 29, 2024

Conversation

mhellmeier
Copy link
Member

Description

This PR initializes the baseline for creating documentation. It uses the Docusaurus documentation framework with GitHub Action pipelines / workflows to automatically update the deployed documentation on every commit on the main branch.

Linked Issue(s)

Fixes #26

CLA

By submitting this pull request, I have read the Corporate Contributor License Agreement (CLA) and I hereby accept and sign the CLA.

@mhellmeier mhellmeier added documentation Improvements or additions to documentation pipeline Build, Action, CI/CD etc. labels May 29, 2024
@mhellmeier mhellmeier requested a review from hnorkowski May 29, 2024 11:02
Copy link
Contributor

@hnorkowski hnorkowski left a comment

Choose a reason for hiding this comment

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

Mostly questions, some wording issues.

@mhellmeier mhellmeier requested a review from hnorkowski May 29, 2024 12:19
Copy link
Contributor

@hnorkowski hnorkowski left a comment

Choose a reason for hiding this comment

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

Only a small nitpick

@mhellmeier mhellmeier requested a review from hnorkowski May 29, 2024 12:29
Copy link
Contributor

@hnorkowski hnorkowski left a comment

Choose a reason for hiding this comment

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

LGTM

@hnorkowski hnorkowski merged commit d0c5f6a into main May 29, 2024
1 check passed
@hnorkowski hnorkowski deleted the docs/init-docusaurus branch May 29, 2024 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pipeline Build, Action, CI/CD etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Setup Documentation Framework
2 participants