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 troubleshooting description language #2325

Merged
merged 2 commits into from
Dec 15, 2023
Merged

Update troubleshooting description language #2325

merged 2 commits into from
Dec 15, 2023

Conversation

npentrel
Copy link
Collaborator

let's remove easy and simple

let's remove easy and simple
@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Dec 15, 2023
@viambot
Copy link
Member

viambot commented Dec 15, 2023

Overall readability score: 56.58 (🟢 +0)

File Readability
troubleshooting.md 59.66 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
troubleshooting.md 59.66 44.44 9.94 12.8 12.24 6.68
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 56.58 48.52 10.49 12.92 11.91 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

docs/appendix/troubleshooting.md Outdated Show resolved Hide resolved
@npentrel npentrel merged commit 87fb2d3 into main Dec 15, 2023
11 checks passed
@npentrel npentrel deleted the npentrel-patch-4 branch December 15, 2023 21:06
@viambot
Copy link
Member

viambot commented Dec 15, 2023

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

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