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 Smart Machines copy #1794

Merged
merged 4 commits into from
Sep 12, 2023
Merged

Update Smart Machines copy #1794

merged 4 commits into from
Sep 12, 2023

Conversation

npentrel
Copy link
Collaborator

@npentrel npentrel commented Sep 11, 2023

No description provided.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Sep 11, 2023
@npentrel npentrel force-pushed the DOCS-1100 branch 15 times, most recently from 724ebe9 to 05a1f88 Compare September 11, 2023 21:36
@viambot
Copy link
Member

viambot commented Sep 11, 2023

Overall readability score: 54.59 (🟢 +0)

File Readability
_index.md 100 (🟢 +0)
smart-machine.md 57.52 (-)
_index.md 25.86 (🔴 -0.4)
_index.md 9.57 (🔴 -0.63)
_index.md 51.23 (🔴 -1.72)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
_index.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
smart-machine.md 57.52 57.61 12.44 11.6 8.94 8.68
  - - - - - -
_index.md 25.86 31.85 15.75 22 14.57 8.27
  🔴 -0.4 🔴 -0.21 🔴 -0.05 🟢 +0 🔴 -0.29 🟢 +0.04
_index.md 9.57 0 16.21 22 19 9.51
  🔴 -0.63 🟢 +0 🔴 -0.14 🟢 +0 🟢 +0 🔴 -0.12
_index.md 51.23 38.72 10.38 13.6 14.09 7.6
  🔴 -1.72 🔴 -0.61 🟢 +0 🔴 -0.7 🔴 -0.7 🟢 +0.12

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.59 46.15 10.9 13.35 11.82 7.77
  🟢 +0 🟢 +0.03 🔴 -0.01 🟢 +0 🟢 +0.01 🟢 +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 Sep 11, 2023

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

@erh erh merged commit 4b2debe into viamrobotics:main Sep 12, 2023
6 checks passed
@npentrel npentrel deleted the DOCS-1100 branch September 12, 2023 13:33
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