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

doc(refactor): move static docs out of repo to be built automatically #187

Merged
merged 5 commits into from
Mar 26, 2024

Conversation

finger563
Copy link
Contributor

@finger563 finger563 commented Mar 26, 2024

Description

  • Removed static docs folder from repo to help cut down on the number of files changed per PR and ensure docs are always rebuilt properly
  • Added GH Action for CI of docs whenever pushes to main or releases happen.

Motivation and Context

  • Ensures there is less work for contributors
  • Ensures docs are always built for each change
  • Reduces the amount of files / clutter from code changes

How has this been tested?

Running the build and publish docs CI as part of this PR.

Screenshots (if appropriate, e.g. schematic, board, console logs, lab pictures):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update
  • Hardware (schematic, board, system design) change
  • Software change

Checklist:

  • My change requires a change to the documentation.
  • I have added / updated the documentation related to this change via either README or WIKI

Software

  • I have added tests to cover my changes.
  • I have updated the .github/workflows/build.yml file to add my new test to the automated cloud build github action.
  • All new and existing tests passed.
  • My code follows the code style of this project.

* Removed static docs folder from repo to help cut down on the number of files changed per PR and ensure docs are always rebuilt properly
* Added GH Action for CI of docs whenever pushes to main or releases happen.
@finger563 finger563 self-assigned this Mar 26, 2024
@finger563 finger563 added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 26, 2024
Copy link

✅Static analysis result - no issues found! ✅

@finger563 finger563 merged commit 94bba4c into main Mar 26, 2024
55 checks passed
@finger563 finger563 deleted the doc/refactor branch March 26, 2024 13:36
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant