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-1279: Add requirements for services #2160

Conversation

skyleilani
Copy link
Contributor

Add required components for service pages

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

viambot commented Nov 3, 2023

Overall readability score: 55.48 (🟢 +0)

File Readability
_index.md 55.22 (🔴 -7.45)
_index.md 56.09 (🔴 -5.35)
_index.md 49.1 (🔴 -3.1)
_index.md 57.53 (🔴 -1.47)
_index.md 60.03 (🔴 -2.42)
_index.md 63.57 (🔴 -0.81)
sensors.md 58.44 (🔴 -4.55)
_index.md 61.15 (🔴 -2.76)
_index.md 61.54 (🔴 -0.54)
required-legend.md 85.64 (-)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
_index.md 55.22 44.75 10.02 14.3 12.53 7.23
  🔴 -7.45 🔴 -9.47 🔴 -0.51 🔴 -2.1 🔴 -1.16 🔴 -0.1
_index.md 56.09 44.95 10.2 13.8 12.87 6.95
  🔴 -5.35 🔴 -0.71 🔴 -0.3 🔴 -1.9 🔴 -1.21 🔴 -0.08
_index.md 49.1 40.28 12 15.8 13.12 6.91
  🔴 -3.1 🔴 -0.61 🔴 -0.24 🔴 -1 🔴 -0.76 🔴 -0.02
_index.md 57.53 43.53 9.9 14.4 12.07 6.67
  🔴 -1.47 🔴 -0.1 🔴 -0.13 🔴 -0.5 🔴 -0.29 🔴 -0.03
_index.md 60.03 38.52 8.65 13.6 13.51 6.03
  🔴 -2.42 🔴 -8.56 🔴 -0.04 🔴 -0.4 🔴 -0.23 🔴 -0.01
_index.md 63.57 46.37 8.31 13.5 13.05 5.76
  🔴 -0.81 🔴 -0.2 🔴 -0.1 🔴 -0.2 🔴 -0.18 🔴 -0.02
sensors.md 58.44 40.85 7.75 14.5 13.85 6.57
  🔴 -4.55 🔴 -8.97 🔴 -0.35 🔴 -0.8 🔴 -0.7 🔴 -0.1
_index.md 61.15 48.3 8.51 13.5 12.93 6.56
  🔴 -2.76 🔴 -0.4 🔴 -0.28 🔴 -0.8 🔴 -0.47 🔴 -0.12
_index.md 61.54 39.03 7.99 14.2 13.39 5.72
  🔴 -0.54 🟢 +0 🔴 -0.03 🔴 -0.2 🔴 -0.12 🔴 -0.01
required-legend.md 85.64 93.81 6 6 6 9.05
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.48 46.95 10.63 13.03 12.05 7.72
  🟢 +0 🟢 +0.05 🟢 +0.01 🟢 +0 🟢 +0 🔴 -0.01
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/services/ml/_index.md Outdated Show resolved Hide resolved
docs/services/sensors.md Outdated Show resolved Hide resolved
@skyleilani
Copy link
Contributor Author

skyleilani commented Nov 3, 2023

Shortcode relatedcard includes italicization for required components.
Shortcode relatedcard1 includes an asterisk after the title for required components.

BaseRC contains an example of required components being italicized, other pages show relatedcard1 using an asterisk.

@skyleilani skyleilani requested a review from npentrel November 6, 2023 14:59
@npentrel
Copy link
Collaborator

npentrel commented Nov 8, 2023

Let's go with the asterisk for required components. The italics I missed to begin with. This is looking very good!!

By Service:

  • Data Management, Frame system, and ML Model Service miss the section. Data Management should have many components, ML Model should display the vision service
  • For the motion service I think we also want to add the frame system. So maybe the Component required for use should become Required for use

@skyleilani skyleilani requested a review from npentrel November 9, 2023 14:49
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.

Two more small changes but otherwise looks good.

@viambot
Copy link
Member

viambot commented Nov 10, 2023

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

@skyleilani skyleilani merged commit fe1e640 into viamrobotics:main Nov 10, 2023
11 checks passed
@skyleilani skyleilani deleted the DOCS-1279-Add-requirements-for-services branch November 10, 2023 15:25
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