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 machines.md #2853

Merged
merged 2 commits into from
May 1, 2024
Merged

Update machines.md #2853

merged 2 commits into from
May 1, 2024

Conversation

JessamyT
Copy link
Collaborator

Split the tip alert because it contains two separate ideas

Add mention of the Viam app for context

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Apr 30, 2024
@viambot
Copy link
Member

viambot commented Apr 30, 2024

Overall readability score: 55.36 (🟢 +0)

File Readability
machines.md 51.17 (🔴 -0.43)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
machines.md 51.17 47.42 12.22 15.7 11.96 7.07
  🔴 -0.43 🔴 -0.3 🔴 -0.12 🔴 -0.1 🟢 +0 🔴 -0.01

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.36 47.63 10.8 13.26 12.03 7.61
  🟢 +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

docs/fleet/machines.md Outdated Show resolved Hide resolved
docs/fleet/machines.md Outdated Show resolved Hide resolved
docs/fleet/machines.md Outdated Show resolved Hide resolved
@viambot
Copy link
Member

viambot commented Apr 30, 2024

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

@npentrel npentrel merged commit 9988659 into main May 1, 2024
11 checks passed
@npentrel npentrel deleted the JessamyT-patch-2 branch May 1, 2024 09:20
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