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: move README contents to documentation #159

Merged
merged 5 commits into from
Jun 2, 2024

Conversation

drwnz
Copy link
Collaborator

@drwnz drwnz commented Jun 2, 2024

PR Type

  • Improvement

Related Links

Description

Moves README contents to documentation.
Note: this is only a first step, there are many more documentation changes required!

Review Procedure

Remarks

Pre-Review Checklist for the PR Author

PR Author should check the checkboxes below when creating the PR.

  • Assign PR to reviewer

Checklist for the PR Reviewer

Reviewers should check the checkboxes below before approval.

  • Commits are properly organized and messages are according to the guideline
  • (Optional) Unit tests have been written for new behavior
  • PR title describes the changes

Post-Review Checklist for the PR Author

PR Author should check the checkboxes below before merging.

  • All open points are addressed and tracked via issues or tickets

CI Checks

  • Build and test for PR: Required to pass before the merge.

@drwnz drwnz requested a review from mojomex June 2, 2024 06:50
drwnz added 2 commits June 2, 2024 15:58
Signed-off-by: David Wong <[email protected]>
Signed-off-by: David Wong <[email protected]>
docs/supported_sensors.md Outdated Show resolved Hide resolved
docs/supported_sensors.md Outdated Show resolved Hide resolved
docs/supported_sensors.md Outdated Show resolved Hide resolved
docs/tutorials.md Outdated Show resolved Hide resolved
@mojomex mojomex self-requested a review June 2, 2024 08:31
Copy link
Collaborator

@mojomex mojomex left a comment

Choose a reason for hiding this comment

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

LGTM! Ignoring the dead links warning for now as they will exist once deployed to gh pages

@mojomex mojomex merged commit 18848ab into develop Jun 2, 2024
6 of 7 checks passed
@mojomex mojomex mentioned this pull request Jul 18, 2024
5 tasks
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