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-1700: Update registry page #2591

Merged
merged 6 commits into from
Feb 29, 2024
Merged

DOCS-1700: Update registry page #2591

merged 6 commits into from
Feb 29, 2024

Conversation

npentrel
Copy link
Collaborator

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
@viambot
Copy link
Member

viambot commented Feb 27, 2024

Overall readability score: 55.43 (🟢 +0)

File Readability
_index.md 46.47 (🔴 -0.98)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
_index.md 46.47 26.81 10.78 15.9 14.33 7.11
  🔴 -0.98 🔴 -0.81 🔴 -0.37 🔴 -0.2 🟢 +0.17 🔴 -0.05

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/registry/_index.md Outdated Show resolved Hide resolved
docs/registry/_index.md Outdated Show resolved Hide resolved
docs/registry/_index.md Outdated Show resolved Hide resolved
docs/registry/_index.md Outdated Show resolved Hide resolved
docs/registry/_index.md Outdated Show resolved Hide resolved
docs/registry/_index.md Outdated Show resolved Hide resolved
{{% /manualcard %}}
{{% manualcard link="#modular-resources" %}}

{{< glossary_tooltip term_id="modular-resource" text="modular resources" >}} that add capabilities to your machine beyond what is built-in to `viam-server`
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we Bold and capitalize "Modular resources" like we are doing for ML models?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We can but we'd lose the glossary tooltip

Copy link
Contributor

Choose a reason for hiding this comment

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

Then do you want to add a separate title to each card? Just helpful for me when scanning. Ill leave that decision to you as docs owner.

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'll make both boldface, there's something odd happening with headings, so that's easier :)

@viambot
Copy link
Member

viambot commented Feb 29, 2024

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

Copy link
Contributor

@nataliajacobowitz nataliajacobowitz left a comment

Choose a reason for hiding this comment

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

it looks good to me now thank you!

@npentrel npentrel merged commit bd3a846 into main Feb 29, 2024
10 of 11 checks passed
@npentrel npentrel deleted the npentrel-patch-1 branch February 29, 2024 16:05
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.

None yet

3 participants