DOCS-1653: R2D2 Docs Updates #2433

sguequierre · 2024-01-25T19:56:36Z

All R2D2 work should be based off this branch

viambot · 2024-01-25T19:57:40Z

Overall readability score: 55.36 (🔴 -0.03)

File	Readability
changelog.md	36.52 (🔴 -0.13)
part.md	8.99 (🔴 -7.59)
remote-part.md	65.61 (-)
resource.md	6.36 (🟢 +0)
setup.md	55.62 (-)
troubleshooting.md	59.06 (🔴 -0.38)
_index.md	57.32 (🟢 +0.5)

View detailed metrics

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

File	Readability	FRE	GF	ARI	CLI	DCRS
changelog.md	36.52	33.28	15.05	18.7	13.07	7.55
	🔴 -0.13	🟢 +0	🔴 -0.01	🟢 +0	🔴 -0.06	🔴 -0.01
part.md	8.99	5.32	17.06	22	19	9.51
	🔴 -7.59	🔴 -6.9	🔴 -3.18	🟢 +0	🟢 +0	🔴 -0.31
remote-part.md	65.61	54.39	8.11	10.5	13.42	6.84
	-	-	-	-	-	-
resource.md	6.36	0	16	22	19	10.62
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0
setup.md	55.62	48.13	11.19	15.3	12.42	6.25
	-	-	-	-	-	-
troubleshooting.md	59.06	44.44	9.99	13	12.42	6.67
	🔴 -0.38	🟢 +0.1	🟢 +0	🔴 -0.1	🔴 -0.18	🟢 +0
_index.md	57.32	42.11	10.47	14.2	12.13	6.42
	🟢 +0.5	🔴 -0.1	🟢 +0.02	🔴 -0.1	🟢 +0.17	🟢 +0.12

Averages:

	Readability	FRE	GF	ARI	CLI	DCRS
Average	55.36	47.43	10.79	13.27	12.04	7.59
	🔴 -0.03	🟢 +0.1	🔴 -0.1	🔴 -0.01	🟢 +0.06	🟢 +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

npentrel

I think I asked on the other PR but did you check they're definitely keeping the all caps on CONFIGURE?

npentrel · 2024-01-29T12:12:29Z

docs/registry/configure.md

+2. Click the **+** icon next to your machine part in the left-hand menu and select **Component**.
+3. Browse the list of available component types, and select the specific modular component you'd like to add.


just making sure: you know you don't need to change these right? It will automatically render to be the correct numbers

Yeah I know-- my vscode does that

Let me know if you want to look at turning that off together 🙃

npentrel · 2024-01-29T12:13:05Z

static/include/snippet/show-secret.md

@@ -3,7 +3,6 @@ By default, the sample code does not include your machine API key and API key ID
 We strongly recommend that you add your API key and API key ID as an environment variable and import this variable into your development environment as needed.

 To show your machine's API key and API key ID in the sample code, toggle **Include secret** on the **Code sample** tab.
-You can also see your API key and API key ID on your machine's **Security** tab.


That's no longer true?

No more security tab. I have another ticket to update that workflow

sguequierre · 2024-01-29T15:27:19Z

I think I asked on the other PR but did you check they're definitely keeping the all caps on CONFIGURE?

Checking now!

edit: Yes

docs/appendix/changelog.md

…on RBAC page R2D2 (#2412)

…ab R2D2 (#2431)

docs/mobility/slam/cartographer/_index.md

sguequierre · 2024-04-16T14:54:58Z

.github/ISSUE_TEMPLATE/bug_report.md

@@ -11,6 +11,7 @@ A clear and concise description of what the bug is.

 **To Reproduce**
 Steps to reproduce the behavior:


These changes were intentional and to stop vale from complaining about it

…2778)

viambot · 2024-04-16T18:47:12Z

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

Co-authored-by: Naomi Pentrel <[email protected]> Co-authored-by: JessamyT <[email protected]> Co-authored-by: sky leilani <[email protected]>

viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jan 25, 2024

npentrel approved these changes Jan 29, 2024

View reviewed changes

sguequierre force-pushed the R2D2 branch from 7bcab73 to 1d28d6a Compare January 31, 2024 18:36

sguequierre commented Jan 31, 2024

View reviewed changes

docs/appendix/changelog.md Outdated Show resolved Hide resolved

sguequierre force-pushed the R2D2 branch from b7b5ffd to 3d115cc Compare February 20, 2024 20:21

sguequierre commented Feb 20, 2024

View reviewed changes

docs/appendix/changelog.md Outdated Show resolved Hide resolved

sguequierre force-pushed the R2D2 branch from dab0b9a to 6c1759e Compare February 20, 2024 20:26

sguequierre commented Feb 20, 2024

View reviewed changes

docs/appendix/changelog.md Outdated Show resolved Hide resolved

sguequierre force-pushed the R2D2 branch from b0b3000 to 3b30ceb Compare February 20, 2024 21:19

sguequierre commented Feb 21, 2024

View reviewed changes

docs/appendix/changelog.md Outdated Show resolved Hide resolved

sguequierre and others added 12 commits February 23, 2024 11:16

DOCS-1667/1713: Update docs for security tab removal and update tabs …

fdc73d8

…on RBAC page R2D2 (#2412)

DOCS-1657: R2D2 Update add component and service instructions (#2411)

53a24f9

DOCS-1655/DOCS-1670: Remove Raw from JSON and make config CONFIGURE t…

6ee1804

…ab R2D2 (#2431)

DOCS-1662: Change Code sample tab to page on CONNECT tab (#2445)

a3ba269

Update vision svc organization to be by model (#2424)

cf4defc

DOCS-1655/DOCS-1670: Remove Raw from JSON and make config CONFIGURE t…

b6b5f4f

…ab R2D2 (#2431)

Update mlmodel.md

a975c7b

Apply suggestions from code review

10e882f

Update docs/appendix/changelog.md

352e73a

Fix link

8ff0009

DOCS-1782: Module card updates on registry/configure R2D2 (#2557)

1dba28e

DOCS-1789: Update for Auth/Network tab removal R2D2 (#2561)

99f8e66

sguequierre force-pushed the R2D2 branch from e2b5758 to 99f8e66 Compare February 23, 2024 16:16

Merge branch 'main' into R2D2

d428b64

sguequierre commented Mar 6, 2024

View reviewed changes

docs/mobility/slam/cartographer/_index.md Outdated Show resolved Hide resolved

sguequierre added 3 commits March 6, 2024 13:18

Apply suggestions from code review

c713cdc

Merge branch 'main' into R2D2

9e183b5

Merge branch 'main' into R2D2

1048abe

sguequierre added 8 commits April 15, 2024 17:11

remove e.g.

e19957e

DOCS-2115: Update base screenshots R2D2 (#2776)

fe0d629

DOCS-2117: Update camera config builder screenshots R2D2 (#2775)

df9f754

DOCS-2122: Update ml model service for R2D2 (#2777)

7016acf

DOCS-2118: Update input controller builder mode (except gpio) (#2765)

27716a1

DOCS-2121: Update base remote control for R2D2 (#2767)

ed2b7d9

DOCS-2153: Update motor screenshots R2D2 (#2782)

18fb723

Merge branch 'main' into R2D2

30e1ae6

sguequierre commented Apr 16, 2024

View reviewed changes

JessamyT and others added 17 commits April 16, 2024 16:57

DOCS-1938: Update Grafana tutorial R2D2 (#2762)

3ad8d7a

DOCS-1959: Edit mousemover tutorial for R2D2 (#2747)

fd698e5

DOCS-1940: Update filtered camera tutorial for R2D2 (#2779)

077e57b

DOCS-2152: Update encoder screenshots for R2D2 (#2781)

6cb99b6

DOCS-1937: Update helmet tutorial instructions and screenshots R2D2 (#…

63b5c89

…2778)

DOCS-2123: Update navigation screenshot for R2D2 (#2768)

828a95b

DOCS-2119: Update power sensor for R2D2 (#2766)

d49a974

DOCS-2116: Update board config builders R2D2 (#2764)

1fbd213

Fix api key image R2D2 (#2785)

82eb1d6

DOCS-2124: Update CV screenshots R2D2 (#2774)

ce6d4e6

fixup build/configure

e1cf4c5

Update remote selection remove old method R2D2 (#2786)

051852b

DOCS-1936: Review navigate with rover base tutorial R2D2 (#2780)

5c9af5c

Merge branch 'main' into R2D2

24ff73e

change heading level

55ae56b

fix link

155f583

Merge branch 'main' into R2D2

f772048

sguequierre merged commit 59dee5b into main Apr 16, 2024
9 of 10 checks passed

sguequierre deleted the R2D2 branch April 16, 2024 20:11

sguequierre added a commit to sguequierre/docs that referenced this pull request Apr 25, 2024

DOCS-1653: R2D2 Docs Updates (viamrobotics#2433)

99497ab

Co-authored-by: Naomi Pentrel <[email protected]> Co-authored-by: JessamyT <[email protected]> Co-authored-by: sky leilani <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCS-1653: R2D2 Docs Updates #2433

DOCS-1653: R2D2 Docs Updates #2433

sguequierre commented Jan 25, 2024 •

edited

Loading

viambot commented Jan 25, 2024 •

edited

Loading

npentrel left a comment

npentrel Jan 29, 2024

sguequierre Jan 29, 2024

npentrel Jan 29, 2024

npentrel Jan 29, 2024

sguequierre Jan 29, 2024

sguequierre commented Jan 29, 2024 •

edited

Loading

sguequierre Apr 16, 2024

viambot commented Apr 16, 2024

		2. Click the + icon next to your machine part in the left-hand menu and select Component.
		3. Browse the list of available component types, and select the specific modular component you'd like to add.

		@@ -11,6 +11,7 @@ A clear and concise description of what the bug is.

		To Reproduce
		Steps to reproduce the behavior:

DOCS-1653: R2D2 Docs Updates #2433

DOCS-1653: R2D2 Docs Updates #2433

Conversation

sguequierre commented Jan 25, 2024 • edited Loading

viambot commented Jan 25, 2024 • edited Loading

npentrel left a comment

Choose a reason for hiding this comment

npentrel Jan 29, 2024

Choose a reason for hiding this comment

sguequierre Jan 29, 2024

Choose a reason for hiding this comment

npentrel Jan 29, 2024

Choose a reason for hiding this comment

npentrel Jan 29, 2024

Choose a reason for hiding this comment

sguequierre Jan 29, 2024

Choose a reason for hiding this comment

sguequierre commented Jan 29, 2024 • edited Loading

sguequierre Apr 16, 2024

Choose a reason for hiding this comment

viambot commented Apr 16, 2024

sguequierre commented Jan 25, 2024 •

edited

Loading

viambot commented Jan 25, 2024 •

edited

Loading

sguequierre commented Jan 29, 2024 •

edited

Loading