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-1070: Pt3: Update UI on several more tutorials #1783

Merged
merged 5 commits into from
Sep 13, 2023

Conversation

JessamyT
Copy link
Collaborator

@JessamyT JessamyT commented Sep 9, 2023

Also updates the movement sensor screenshots

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Sep 9, 2023
@JessamyT JessamyT marked this pull request as draft September 9, 2023 00:29
@JessamyT JessamyT marked this pull request as ready for review September 9, 2023 00:59
@viambot
Copy link
Member

viambot commented Sep 12, 2023

Overall readability score: 54.55 (🔴 -0.04)

File Readability
upboard.md 52.06 (🔴 -8.41)
model1.md 46.96 (🔴 -6.68)
adxl345.md 44.71 (🔴 -1.67)
wheeled-odometry.md 56.69 (🟢 +0.26)
configuration.md 47.65 (🟢 +0)
custom-base-dog.md 52.65 (🟢 +1.23)
blink-an-led.md 67.39 (🟢 +0)
claw-game.md 72.46 (🟢 +0.36)
foam-dart-launcher.md 59.54 (🟢 +0.99)
guardian.md 71.09 (🟢 +0.63)
light-up.md 71.19 (🟢 +0.12)
modernize-retro-robot.md 80.72 (🟢 +0.38)
send-security-photo.md 68.6 (🟢 +0.09)
webcam-line-follower-robot.md 74.42 (🟢 +1.11)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
upboard.md 52.06 43.8 10.02 12.5 12.91 8.81
  🔴 -8.41 🔴 -8.25 🔴 -0.92 🔴 -1.2 🔴 -0.98 🔴 -0.73
model1.md 46.96 44.75 11.89 15.4 12.47 8.33
  🔴 -6.68 🔴 -9.47 🔴 -0.81 🔴 -1.2 🔴 -0.52 🔴 -0.39
adxl345.md 44.71 45.49 13.28 17.7 12.19 7.41
  🔴 -1.67 🔴 -1.22 🔴 -0.32 🔴 -0.7 🟢 +0 🟢 +0.03
wheeled-odometry.md 56.69 39.13 10.61 11.9 12.81 7.13
  🟢 +0.26 🔴 -0.1 🟢 +0.02 🔴 -0.1 🟢 +0 🟢 +0.12
configuration.md 47.65 35.51 13.08 16.5 11.78 6.81
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
custom-base-dog.md 52.65 44.58 12.82 15.6 10.86 6.67
  🟢 +1.23 🟢 +0.71 🟢 +0.25 🟢 +0.4 🟢 +0.05 🟢 +0.01
blink-an-led.md 67.39 58.32 10.46 12.5 9.11 6.22
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
claw-game.md 72.46 60.95 9.23 10.8 9.46 6.05
  🟢 +0.36 🟢 +0.2 🟢 +0.09 🟢 +0.1 🟢 +0 🟢 +0.01
foam-dart-launcher.md 59.54 56.89 11.12 14.4 11.09 6.51
  🟢 +0.99 🟢 +0.5 🟢 +0.2 🟢 +0.3 🟢 +0 🟢 +0.04
guardian.md 71.09 60.35 9.61 11.2 9.46 6.06
  🟢 +0.63 🟢 +0.31 🟢 +0.13 🟢 +0.2 🟢 +0 🟢 +0.02
light-up.md 71.19 62.17 8.94 10.9 9.86 6.44
  🟢 +0.12 🟢 +0.2 🟢 +0.08 🟢 +0 🔴 -0.06 🟢 +0.01
modernize-retro-robot.md 80.72 70.94 8.36 9.3 8.29 5.65
  🟢 +0.38 🟢 +0.21 🟢 +0.08 🟢 +0.1 🟢 +0 🟢 +0.02
send-security-photo.md 68.6 54.32 8.9 11.1 10.44 6.52
  🟢 +0.09 🟢 +0.2 🟢 +0.08 🟢 +0 🔴 -0.06 🟢 +0
webcam-line-follower-robot.md 74.42 63.09 8.85 9.9 9.39 6.19
  🟢 +1.11 🟢 +0.61 🟢 +0.26 🟢 +0.3 🟢 +0 🟢 +0.04

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.55 46.1 10.9 13.35 11.83 7.77
  🔴 -0.04 🔴 -0.05 🟢 +0 🔴 -0.01 🟢 +0 🟢 +0
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

Copy link
Contributor

@andf-viam andf-viam left a comment

Choose a reason for hiding this comment

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

LGTM with some tiny nits. Great catches / fixes in there, thank you!!

In the attributes field, paste the following, replacing `<HOSTNAME>` with your Pi's hostname (for example, `"ip_address": "robotdog.local"`):
### Configure the base

Because your custom base relies on a local module, you need to use raw JSON to configure your modular resource.
Copy link
Contributor

Choose a reason for hiding this comment

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

[No action] Not for this PR, but I have docs for adding a local module in progress that may change this. #1815 if you're curious. Definitely a follow-up task, perhaps for me!

@viambot
Copy link
Member

viambot commented Sep 13, 2023

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

@JessamyT JessamyT merged commit 3c9770c into viamrobotics:main Sep 13, 2023
@JessamyT JessamyT deleted the 1070tutes branch September 13, 2023 16:36
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