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-1517: Update rpi os setup #2322

Merged

Conversation

skyleilani
Copy link
Contributor

Update images containing the Raspberry Pi Lite os to the Raspberry Pi Legacy Full os.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Dec 13, 2023
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.

Thanks for tackling this! Two things:

  • Is 32-bit correct? I thought we'd need the Raspberry Pi OS Full (64-bit) image to workaround the current wifi issue?
  • We also need to update the text to match, such as step 2 here.

@viambot
Copy link
Member

viambot commented Dec 15, 2023

Overall readability score: 56.54 (🔴 -0.12)

File Readability
rpi-setup.md 45.01 (🟢 +0)
custom-base-dog.md 70.66 (🟢 +0.26)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
rpi-setup.md 45.01 33.24 11.29 17.2 14.62 6.91
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
custom-base-dog.md 70.66 54.32 9.01 10.5 10.15 6.22
  🟢 +0.26 🟢 +0.1 🟢 +0.04 🟢 +0.1 🟢 +0 🟢 +0.01

Averages:

  Readability FRE GF ARI CLI DCRS
Average 56.54 48.45 10.49 12.93 11.92 7.64
  🔴 -0.12 🔴 -0.12 🔴 -0.02 🔴 -0.03 🔴 -0.02 🟢 +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.

This LGTM % one additional spot. Thanks for this!

I found one more instance here: /tutorials/custom/custom-base-dog.md - I'd recommend just making that mention generic: to install Raspberry Pi OS.

@skyleilani
Copy link
Contributor Author

This LGTM % one additional spot. Thanks for this!

I found one more instance here: /tutorials/custom/custom-base-dog.md - I'd recommend just making that mention generic: to install Raspberry Pi OS.

Thank you so much for the review!

@viambot
Copy link
Member

viambot commented Dec 16, 2023

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

@skyleilani skyleilani merged commit 00264ef into viamrobotics:main Dec 16, 2023
11 checks passed
@skyleilani skyleilani deleted the DOCS-1517-Update-rpi-os-setup branch December 16, 2023 02:52
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