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-1829: Make carousel shortcode and rearrange Build #2634

Merged
merged 4 commits into from
Mar 11, 2024

Conversation

JessamyT
Copy link
Collaborator

@JessamyT JessamyT commented Mar 9, 2024

Note to reviewers: The only change to the big HTML chunk in Build is changing services h2 to h3.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Mar 9, 2024
@viambot
Copy link
Member

viambot commented Mar 9, 2024

Overall readability score: 55.27 (🔴 -0.3)

File Readability
_index.md 39.68 (🔴 -2.85)
_index.md 0 (🔴 -100)
viam.md 52.05 (🟢 +0.38)
platform.md 1.58 (🔴 -20.76)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
_index.md 39.68 34.66 12.28 17.5 15.14 7.75
  🔴 -2.85 🔴 -8.16 🟢 +0.37 🔴 -1.6 🔴 -0.98 🟢 +0.49
_index.md 0 0 19 22 19 11
  🔴 -100 🔴 -100 🔴 -13 🔴 -16 🔴 -13 🔴 -6.1
viam.md 52.05 39.23 10.24 13.5 14.03 7.52
  🟢 +0.38 🟢 +0.1 🟢 +0.04 🟢 +0.1 🟢 +0.06 🟢 +0.02
platform.md 1.58 9.56 19 22 19 11
  🔴 -20.76 🔴 -27.23 🔴 -7.43 🔴 -0.3 🔴 -1.78 🔴 -0.18

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.27 47.1 10.69 13.26 12.13 7.62
  🔴 -0.3 🔴 -0.33 🔴 -0.05 🔴 -0.04 🔴 -0.04 🔴 -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/build/_index.md Outdated Show resolved Hide resolved
docs/build/_index.md Outdated Show resolved Hide resolved
@@ -7,119 +7,7 @@ layout: "empty"
empty_node: true
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is actually not an empty node anymore and it should also not have the layout: "empty"

Suggested change
empty_node: true

Copy link
Collaborator Author

@JessamyT JessamyT Mar 11, 2024

Choose a reason for hiding this comment

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

Ah okay I commented out both of those lines temporarily to test it locally but figured you'd had these lines in here for a reason so left as-is! Hmm it seems like this page isn't formatted nicely currently (with the four boxes and then three smaller ones--looks awk)--I will make a ticket to un-empty_node this in a separate PR so that its contents can be reviewed

@npentrel
Copy link
Collaborator

Great work - a few small comments

@viambot
Copy link
Member

viambot commented Mar 11, 2024

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

@JessamyT JessamyT merged commit 9750d51 into viamrobotics:main Mar 11, 2024
10 checks passed
@JessamyT JessamyT deleted the 1829carousel branch March 11, 2024 18:24
sguequierre pushed a commit to sguequierre/docs that referenced this pull request Apr 25, 2024
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