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

Update tutorial ordering #2353

Merged
merged 1 commit into from
Dec 21, 2023
Merged

Update tutorial ordering #2353

merged 1 commit into from
Dec 21, 2023

Conversation

npentrel
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 Dec 21, 2023
@npentrel npentrel merged commit 7f463ed into viamrobotics:main Dec 21, 2023
10 checks passed
@viambot
Copy link
Member

viambot commented Dec 21, 2023

Overall readability score: 56.36 (🟢 +0)

File Readability
pet-photographer.md 59.65 (🟢 +0)
claw-game.md 72.64 (🟢 +0)
guardian.md 72.5 (🟢 +0)
integrating-viam-with-openai.md 64.16 (🟢 +0.11)
make-a-plant-watering-robot.md 72.44 (🟢 +0)
accessing-and-moving-robot-arm.md 60.8 (🟢 +0)
navigate-with-rover-base.md 64.44 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
pet-photographer.md 59.65 43.53 9.68 13.9 12.53 6.15
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
claw-game.md 72.64 61.06 9.2 10.7 9.46 6.06
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
guardian.md 72.5 60.95 9.39 10.7 9.34 6.05
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
integrating-viam-with-openai.md 64.16 52.9 10.2 11.8 10.73 6.69
  🟢 +0.11 🟢 +0 🟢 +0 🟢 +0.1 🟢 +0 🔴 -0.01
make-a-plant-watering-robot.md 72.44 62.27 9.15 10.5 9.74 6.18
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
accessing-and-moving-robot-arm.md 60.8 50.06 11.04 13 10.5 6.7
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
navigate-with-rover-base.md 64.44 45.15 8.98 12.5 11.66 6.13
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 56.36 48.31 10.52 12.97 11.94 7.65
  🟢 +0 🟢 +0 🟢 +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

@viambot
Copy link
Member

viambot commented Dec 21, 2023

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

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.

2 participants