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-1029: add sensor control view #1840

Merged

Conversation

skyleilani
Copy link
Contributor

Add a view of the control tab for the sensor component.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Sep 15, 2023
@viambot
Copy link
Member

viambot commented Sep 15, 2023

Overall readability score: 54.35 (🔴 -0.14)

File Readability
bme280.md 53.14 (🔴 -9.88)
ds18b20.md 43.45 (🔴 -9.32)
fake.md 36.05 (🔴 -11.92)
sensirion-sht3xd.md 56.81 (🔴 -8.83)
ultrasonic.md 48.02 (🔴 -5.93)
sensor-control.md 57.07 (-)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
bme280.md 53.14 48.3 10.28 13.3 12.06 8.58
  🔴 -9.88 🔴 -8.66 🔴 -0.35 🔴 -2.2 🔴 -1.86 🔴 -0.63
ds18b20.md 43.45 39.03 11.69 14.4 13.33 9.31
  🔴 -9.32 🔴 -8.76 🔴 -0.36 🔴 -2 🔴 -1.74 🔴 -0.59
fake.md 36.05 35.27 11.39 18.1 14.1 9.57
  🔴 -11.92 🔴 -8.87 🔴 -0.51 🔴 -2.7 🔴 -2.26 🔴 -0.77
sensirion-sht3xd.md 56.81 57.37 9.88 12.8 11.82 8.45
  🔴 -8.83 🔴 -0.3 🔴 -0.4 🔴 -2.2 🔴 -1.97 🔴 -0.66
ultrasonic.md 48.02 46.57 10.92 15.6 13.34 8.14
  🔴 -5.93 🔴 -0.21 🔴 -0.27 🔴 -1.5 🔴 -1.28 🔴 -0.45
sensor-control.md 57.07 57.27 9.41 11.5 12.64 8.84
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.35 45.86 10.88 13.38 11.91 7.79
  🔴 -0.14 🔴 -0.05 🟢 +0 🔴 -0.03 🔴 -0.03 🔴 -0.01
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@skyleilani skyleilani requested a review from npentrel September 15, 2023 18:46
Copy link
Collaborator

@npentrel npentrel left a comment

Choose a reason for hiding this comment

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

Well done!

@viambot
Copy link
Member

viambot commented Sep 18, 2023

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3d3490d0f3519cae6a5cedc879b617c69340ed4c/public

@skyleilani skyleilani merged commit 1d210fc into viamrobotics:main Sep 18, 2023
7 checks passed
@skyleilani skyleilani deleted the DOCS-1029-add-sensor-control-view branch September 18, 2023 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants