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: Pt5: Update UI on more tutorials #1868

Merged
merged 7 commits into from
Sep 20, 2023

Conversation

JessamyT
Copy link
Collaborator

No description provided.

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

viambot commented Sep 19, 2023

Overall readability score: 54.45 (🟢 +0.01)

File Readability
viam-visual-odometry.md 51.53 (🟢 +1.08)
lazy-susan.md 74.04 (🟢 +0.47)
servo-mousemover.md 76.92 (🟢 +1.81)
integrating-viam-with-openai.md 63.64 (🟢 +0)
light-up.md 73.4 (🟢 +0.18)
send-security-photo.md 69.78 (🟢 +0.1)
tipsy.md 69.36 (🟢 +1.18)
data-management-tutorial.md 69.92 (🔴 -0.06)
plan-motion-with-arm-gripper.md 54.91 (🔴 -1.09)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
viam-visual-odometry.md 51.53 37.3 10.95 13.2 13.16 7.72
  🟢 +1.08 🟢 +0.61 🟢 +0.26 🟢 +0.3 🟢 +0 🟢 +0.03
lazy-susan.md 74.04 62.27 9.02 10 8.93 6.33
  🟢 +0.47 🟢 +0.3 🟢 +0.14 🟢 +0.1 🟢 +0 🟢 +0.01
servo-mousemover.md 76.92 62.88 8.75 9.2 8.41 6.2
  🟢 +1.81 🟢 +0.81 🟢 +0.41 🟢 +0.5 🟢 +0.11 🟢 +0.03
integrating-viam-with-openai.md 63.64 51.99 10.53 11.9 10.33 6.76
  🟢 +0 🟢 +0.1 🟢 +0.04 🟢 +0 🔴 -0.06 🟢 +0
light-up.md 73.4 62.58 8.66 10.3 9.39 6.4
  🟢 +0.18 🟢 +0 🟢 +0.07 🟢 +0 🔴 -0.05 🟢 +0.04
send-security-photo.md 69.78 54.83 8.64 10.8 10.38 6.48
  🟢 +0.1 🟢 +0 🟢 +0.05 🟢 +0 🔴 -0.06 🟢 +0.03
tipsy.md 69.36 54.52 8.62 11.4 10.96 6.08
  🟢 +1.18 🟢 +0.71 🟢 +0.3 🟢 +0.3 🔴 -0.06 🟢 +0.06
data-management-tutorial.md 69.92 54.32 9.05 10.4 9.97 6.55
  🔴 -0.06 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🔴 -0.02
plan-motion-with-arm-gripper.md 54.91 48.74 11.69 15 11.49 6.78
  🔴 -1.09 🔴 -0.41 🔴 -0.15 🔴 -0.2 🔴 -0.29 🔴 -0.02

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.45 45.92 10.86 13.36 11.9 7.78
  🟢 +0.01 🟢 +0.01 🟢 +0 🟢 +0 🟢 +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!! One thought about omitting "or name it something else" phrasing, but otherwise great stuff -- thanks so much!

Comment on lines +167 to +168
You can name the board whatever you want.
You will reference it later.
Copy link
Contributor

Choose a reason for hiding this comment

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

What do you think of deleting these lines outright? We are already proposing a value for the board name. For tutorial context, I think it is appropriate to use an example name throughout: local.

Same with FS90R below.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think that, since the board name is used in configuring the servo but not in the code, that it's fine to keep this note in as a learning moment?

Copy link
Contributor

Choose a reason for hiding this comment

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

Alright that works. I'm just trying to avoid this kind of language:
"this value you entered does not matter"
"but it's important at an unspecified later date, don't forget"

Goal: names are up to you! But for this specific tutorial, use this one in particular
Actual: an aside about naming not mattering in the middle of actionable steps.

Feel free to retain if you find it helpful, I find it potentially convoluting!

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.

Recent changes still LGTM!

@viambot
Copy link
Member

viambot commented Sep 20, 2023

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

@JessamyT JessamyT merged commit dbf155a into viamrobotics:main Sep 20, 2023
@JessamyT JessamyT deleted the 1070ui5 branch September 20, 2023 22:49
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