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-1099: Update note.md #1777

Merged
merged 4 commits into from
Sep 12, 2023
Merged

DOCS-1099: Update note.md #1777

merged 4 commits into from
Sep 12, 2023

Conversation

skyleilani
Copy link
Contributor

Description

Include alert title section in note.md

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Sep 8, 2023
@skyleilani skyleilani changed the title Update-Note-md Update-note-md Sep 8, 2023
@npentrel
Copy link
Collaborator

npentrel commented Sep 8, 2023

I think this might work better in this section? https://docs-test.viam.dev/01f02789e2b6630cbcfb449a985d424643fe2d2a/public/note/#how-to-use-notes-cautions-and-warnings

@skyleilani skyleilani changed the title Update-note-md DOCS-1099: Update note.md Sep 8, 2023
@@ -214,6 +214,8 @@ await arm.move_to_position(pose=pos, world_state=worldstate)
They both use the same color.

**Note/Important/Stability Notice**: These call attention to something important.
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
**Note/Important/Stability Notice**: These call attention to something important.
**Important/Stability Notice**: These call attention to something important.

Out of diff but I realized this should be changed as well

@viambot
Copy link
Member

viambot commented Sep 12, 2023

Overall readability score: 54.59 (🟢 +0)

File Readability
note.md 51.36 (🟢 +0.68)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
note.md 51.36 47.93 11.72 16.2 11.84 7.13
  🟢 +0.68 🟢 +0.41 🟢 +0.15 🟢 +0.2 🟢 +0 🟢 +0.02

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.59 46.15 10.89 13.35 11.82 7.77
  🟢 +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

@viambot
Copy link
Member

viambot commented Sep 12, 2023

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

@skyleilani skyleilani merged commit a757eea into main Sep 12, 2023
7 checks passed
@skyleilani skyleilani deleted the Update-note-md branch September 12, 2023 13:40
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.

4 participants