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

Documentation - Docusaurus port #586

Merged

Conversation

InfraredAces
Copy link
Contributor

@InfraredAces InfraredAces commented Oct 19, 2023

This port should contain all of the current documentation that is live on the documentation site as of the time of this PR.

I have a test version of this site running one https://infraredaces.github.io/docusaurus-test/ , if you would like to see it live and test.

There are only a few things left to do before and after this PR is merged to allow the workflow to deploy the site, but they are only performable by maintainers of the repo.

  • Before: Create an access token with Read and Write access to the Contents of the repo, name it "ACTION_SECRET", and then place it in Repository Secrets. The name can be changed, however the deploy.yml contents will need to be updated as well.

image

  • After: Change the target of the Github Pages to the generated gh-pages branch that the deploy action creates.

image

This action will create a branch of that consists of only the static files generated during the build process and result in the pages seen in the test site linked above.

image

InfraredAces and others added 30 commits October 5, 2023 01:42
Start iterating over config to show in downloads
@InfraredAces InfraredAces marked this pull request as ready for review October 24, 2023 06:53
Copy link
Contributor

@arntsonl arntsonl left a comment

Choose a reason for hiding this comment

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

Going to wait for at least one other review from a web-design stand-point, but I commented on things that stood out to me.

README.md Outdated Show resolved Hide resolved
site/.gitignore Outdated Show resolved Hide resolved
site/README.md Outdated Show resolved Hide resolved
site/docusaurus.config.js Outdated Show resolved Hide resolved
site/docusaurus.config.js Outdated Show resolved Hide resolved
Copy link
Contributor

@arntsonl arntsonl left a comment

Choose a reason for hiding this comment

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

Nice! I'll wait for another reviewer until we merge but changes look good!

arntsonl
arntsonl previously approved these changes Nov 5, 2023
Copy link
Contributor

@arntsonl arntsonl left a comment

Choose a reason for hiding this comment

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

Looks really good!

configs/Pico/BoardConfig.h Outdated Show resolved Hide resolved
site/docs/assets/boards/ReflexEncoder.jpg Outdated Show resolved Hide resolved
@Pelsin
Copy link
Contributor

Pelsin commented Nov 5, 2023

Looks great!
Awesome work!

@arntsonl arntsonl merged commit 00adac8 into OpenStickCommunity:main Nov 5, 2023
63 checks passed
arntsonl added a commit that referenced this pull request Nov 5, 2023
arntsonl added a commit that referenced this pull request Nov 5, 2023
Revert "Documentation - Docusaurus port (#586)"

This reverts commit 00adac8.
@InfraredAces InfraredAces deleted the documentation-docusaurus-port branch November 11, 2023 00:31
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.

4 participants