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-1804: Add hard hat detection tutorial #2616

Merged
merged 9 commits into from
Mar 7, 2024

Conversation

JessamyT
Copy link
Collaborator

@JessamyT JessamyT commented Mar 5, 2024

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

viambot commented Mar 5, 2024

Overall readability score: 55.63 (🟢 +0.05)

File Readability
helmet.md 74.8 (-)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
helmet.md 74.8 57.16 7.67 9.5 10.32 6.17
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.63 47.48 10.64 13.21 12.08 7.6
  🟢 +0.05 🟢 +0.02 🟢 +0.01 🟢 +0.01 🟢 +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

Copy link
Collaborator

@npentrel npentrel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very good - I think a few places where you can add a little more context to make the transitions smoother but I think it's close. The use of functions is a nice thing to show I think.

assets/tutorials/helmet/hardhat-data.png Outdated Show resolved Hide resolved
docs/tutorials/projects/helmet.md Show resolved Hide resolved
docs/tutorials/projects/helmet.md Outdated Show resolved Hide resolved
docs/tutorials/projects/helmet.md Outdated Show resolved Hide resolved
docs/tutorials/projects/helmet.md Outdated Show resolved Hide resolved
docs/tutorials/projects/helmet.md Show resolved Hide resolved
docs/tutorials/projects/helmet.md Outdated Show resolved Hide resolved
docs/tutorials/projects/helmet.md Outdated Show resolved Hide resolved
docs/tutorials/projects/helmet.md Outdated Show resolved Hide resolved
docs/tutorials/projects/helmet.md Outdated Show resolved Hide resolved
@JessamyT JessamyT requested a review from npentrel March 7, 2024 01:27
Copy link
Collaborator

@npentrel npentrel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the updates, I think there's about 3 more comments to resolvemk, then feel free to merge. Great work!

@viambot
Copy link
Member

viambot commented Mar 7, 2024

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

@JessamyT JessamyT merged commit 8c70219 into viamrobotics:main Mar 7, 2024
10 checks passed
@JessamyT JessamyT deleted the 1804safetyhat branch March 7, 2024 22:11
sguequierre pushed a commit to sguequierre/docs that referenced this pull request Apr 25, 2024
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