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-1865: Address customer feedback #2587

Merged
merged 11 commits into from
Feb 27, 2024
Merged

Conversation

npentrel
Copy link
Collaborator

@npentrel npentrel commented Feb 27, 2024

No description provided.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Feb 27, 2024
@npentrel npentrel requested a review from JessamyT February 27, 2024 10:51
@viambot
Copy link
Member

viambot commented Feb 27, 2024

Overall readability score: 55.43 (🟢 +0)

File Readability
_index.md 39.4 (🔴 -0.15)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
_index.md 39.4 44.24 12.81 15.4 14.56 9.25
  🔴 -0.15 🔴 -0.2 🔴 -0.04 🔴 -0.1 🟢 +0 🟢 +0.03

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.43 47.48 10.68 13.24 12.09 7.62
  🟢 +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/ml/_index.md Outdated Show resolved Hide resolved
docs/ml/_index.md Outdated Show resolved Hide resolved
npentrel and others added 2 commits February 27, 2024 21:19
Co-authored-by: JessamyT <[email protected]>
Co-authored-by: JessamyT <[email protected]>
Copy link
Collaborator

@JessamyT JessamyT left a comment

Choose a reason for hiding this comment

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

LGTM % nits

docs/ml/_index.md Outdated Show resolved Hide resolved
docs/ml/_index.md Outdated Show resolved Hide resolved
</td>
</tr>
<tr>
<td>{{<imgproc src="ml/deploy.svg" class="fill alignright" style="max-width: 300px" declaredimensions=true alt="Deploy your model">}}
<b>6. Test your detector or classifier</b>
<p>Test your <a href="/ml/vision/mlmodel/#test-your-detector-or-classifier">mlmodel detector or classifier</a>.</p>
<p>Follow the <a href="/ml/vision/mlmodel/#test-your-detector-or-classifier">instructions to test your mlmodel detector or classifier</a>.</p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<p>Follow the <a href="/ml/vision/mlmodel/#test-your-detector-or-classifier">instructions to test your mlmodel detector or classifier</a>.</p>
<p>Follow the <a href="/ml/vision/mlmodel/#test-your-detector-or-classifier">instructions to test your ML model detector or classifier</a>.</p>

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think it's already very confusing for it to be named the same I'll hangen it to the code version

Copy link
Collaborator

Choose a reason for hiding this comment

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

Out-of-diff nits:

  • Consider sentence casing the heading of step 3
  • Consider adding the word "model" to "machine learning (ML) service" in the first sentence (i.e. change it to "machine learning (ML) model service" for consistency with the rest of the doc

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Isn't it already sentence case?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh you mean number 2

Copy link
Collaborator

Choose a reason for hiding this comment

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

ooh yeah oops

docs/ml/_index.md Outdated Show resolved Hide resolved
docs/ml/_index.md Outdated Show resolved Hide resolved
npentrel and others added 4 commits February 27, 2024 23:29
Co-authored-by: JessamyT <[email protected]>
Co-authored-by: JessamyT <[email protected]>
Co-authored-by: JessamyT <[email protected]>
Co-authored-by: JessamyT <[email protected]>
docs/ml/_index.md Outdated Show resolved Hide resolved
docs/ml/_index.md Outdated Show resolved Hide resolved
@viambot
Copy link
Member

viambot commented Feb 27, 2024

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

@npentrel npentrel merged commit 221a4bc into viamrobotics:main Feb 27, 2024
9 of 10 checks passed
@npentrel npentrel deleted the DOCS-1865 branch February 27, 2024 23:46
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