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

Restructured & Extended #125

Closed
wants to merge 7 commits into from
Closed

Conversation

KasparByrne
Copy link
Contributor

-Restructured to be more robust and naturally guide new members in learning about the existing codebase and Smartbike.
-All new files should be empty, forgot about pushing this earlier.
-Content prepared for some parts but will be included in separate PRs.

Added a slightly wrong PDF covering how the bike's Wahoo devices work with the Raspberry Pi and began integrating and correcting this information into markdown documents. Currently only the general Wahoo Device Interfacing document covering the background knowledge on GATT is complete but have also built the structure for covering other parts of the code.
Restructured the Project 1 part into IoT and VR (VR is currently empty and does not show up). Also tested locally and added a few small changes.
- Moved all BLE documents (only 2) into their own folder for ease of access.
- Added a GATT Common Code document to Wahoo devices to generally document all similar GATT related methods in the Wahoo Driver codes.
- Restructured the documentation

- Added multiple new placeholder documents.

- Added "Onboarding Welcome" document for explaining the project & code.
- Removed ble script contents
- Removed onboarding welcome contents
-Added images that can be referenced anywhere in the documentation
-Added diagrams that can be referenced anywhere in the documentation
-Replacing diagrams with updated info in the future will update all documentation images
Copy link
Contributor

@SassafrasAU SassafrasAU left a comment

Choose a reason for hiding this comment

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

Looks good!

@SassafrasAU
Copy link
Contributor

Merged manually

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