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-1104: Update CLI subcommands plural #1836

Merged

Conversation

andf-viam
Copy link
Contributor

@andf-viam andf-viam commented Sep 14, 2023

Updating CLI reference to standardize on plural for subcommands organizations and robots, merging sections for singular of each into their plural section.

  • Also using the opportunity to standardize on no monospace in headers, and monospace for subcommand in intro sentence of each.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Sep 14, 2023
@viambot
Copy link
Member

viambot commented Sep 14, 2023

Overall readability score: 54.44 (🟢 +0)

File Readability
CLI.md 58.55 (🟢 +0.13)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
CLI.md 58.55 42.51 10.11 14 12.18 6.32
  🟢 +0.13 🟢 +0 🔴 -0.02 🟢 +0.1 🟢 +0.06 🔴 -0.02

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.44 45.91 10.86 13.37 11.89 7.78
  🟢 +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 19, 2023

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

@andf-viam andf-viam merged commit bb73492 into viamrobotics:main Sep 19, 2023
7 checks passed
@andf-viam andf-viam deleted the DOCS-1104-update-cli-subcommands branch September 19, 2023 18:15
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