Skip to content

Auto-sync docs directory to Wiki #149

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

Open
wants to merge 5 commits into
base: development
Choose a base branch
from

Conversation

TheBoatyMcBoatFace
Copy link

Sync docs directory to repo wiki

Streamlines the resolution of #143 and #110 by keeping the docs more up-to-date.

Maintaining GitHub wikis is weird and painful. This PR adds a GitHub workflow that syncs the content in the docs directory to the wiki. I've also copied the content from the current wiki into the new docs directory. If this is merged, whenever an update is made to the docs directory, the content in the wiki is updated.

I also fixed the Example usecase problem where it didn't go anywhere by creating the examples.md page in the docs directory. I copied the content from the config directory into the examples.md file, but left the directory.

This is currently in place on my fork. You can see what the wiki will look like and what the history/updates will look like there.

Type:

  • Bug fix
  • New feature
  • Breaking change
  • Documentation

Camera:

  • GoPro
  • Insta360
  • DJI
  • Android
  • This PR adds a new camera
  • NA

Component:

  • Core logic
  • Import
  • Merging
  • Firmware Update
  • Video Manipulation
  • NA

Checklist before approval:

  • Linter pass
  • Build pass

Signed-off-by: Bentley Hensel <[email protected]>
Signed-off-by: Bentley Hensel <[email protected]>
Signed-off-by: Bentley Hensel <[email protected]>
Signed-off-by: Bentley Hensel <[email protected]>
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.

1 participant