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-1107: Day-of MR tweaks #1812

Merged

Conversation

andf-viam
Copy link
Contributor

Some quick updates to MR language and copy day-of release.

  • Adding note to consider platform support when adding modules
  • Updating uses of module glossary tooltip to consistenly use module as title text instead of modular resource. MR should link instead to key-concepts.
  • Updated glossary entry itself for module to reflect the latest wisdom, and small tweak to resource glossary entry in like fashion.
  • A few more opportunities for linking between reference and procedurals
  • A few language fixes.

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

viambot commented Sep 12, 2023

Overall readability score: 54.5 (🔴 -0.09)

File Readability
module.md 32.4 (🔴 -21.87)
resource.md 4.03 (🔴 -2.3)
_index.md 10.85 (🔴 -0.63)
_index.md 55.5 (🔴 -2.03)
configure.md 62.83 (🟢 +1.95)
_index.md 53.79 (🔴 -1.16)
key-concepts.md 57.54 (🔴 -0.1)
CLI.md 57.41 (🔴 -0.68)
configuration.md 47.34 (🔴 -0.31)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
module.md 32.4 26.81 14.62 15.3 14.04 9.84
  🔴 -21.87 🔴 -23.52 🔴 -1.62 🔴 -6.4 🔴 -2.98 🔴 -0.53
resource.md 4.03 0 16.65 22 19 11
  🔴 -2.3 🟢 +0 🔴 -1.34 🟢 +0 🟢 +0 🟢 +0
_index.md 10.85 0 15.11 22 19 9.7
  🔴 -0.63 🟢 +0 🔴 -0.18 🟢 +0 🟢 +0 🔴 -0.1
_index.md 55.5 34.86 10.32 13.6 12.3 6.89
  🔴 -2.03 🔴 -8.46 🟢 +0.01 🔴 -0.3 🔴 -0.17 🟢 +0.01
configure.md 62.83 44.03 9.02 13.4 12.13 5.94
  🟢 +1.95 🟢 +8.46 🟢 +0.07 🟢 +0.1 🟢 +0.11 🟢 +0.04
_index.md 53.79 41.19 11.05 15.2 12.13 6.71
  🔴 -1.16 🔴 -0.1 🔴 -0.15 🔴 -0.3 🔴 -0.18 🔴 -0.06
key-concepts.md 57.54 38.32 9.85 12.1 12.76 7.16
  🔴 -0.1 🔴 -0.1 🔴 -0.03 🟢 +0 🟢 +0 🔴 -0.01
CLI.md 57.41 42.11 10.25 14.4 12.36 6.32
  🔴 -0.68 🔴 -0.1 🔴 -0.08 🔴 -0.2 🔴 -0.12 🔴 -0.02
configuration.md 47.34 35.41 13.12 16.6 11.84 6.81
  🔴 -0.31 🔴 -0.1 🔴 -0.04 🔴 -0.1 🔴 -0.06 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.5 46.07 10.91 13.37 11.83 7.77
  🔴 -0.09 🔴 -0.08 🔴 -0.01 🔴 -0.02 🔴 -0.01 🟢 +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 13, 2023

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

@andf-viam andf-viam merged commit fe4aca1 into viamrobotics:main Sep 13, 2023
6 checks passed
@andf-viam andf-viam deleted the DOCS-1107-day-of-registry-tweaks branch September 13, 2023 20: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.

2 participants