-
Notifications
You must be signed in to change notification settings - Fork 45
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-1070: Pt5: Update UI on more tutorials #1868
Conversation
Overall readability score: 54.45 (🟢 +0.01)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!! One thought about omitting "or name it something else" phrasing, but otherwise great stuff -- thanks so much!
You can name the board whatever you want. | ||
You will reference it later. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think of deleting these lines outright? We are already proposing a value for the board name. For tutorial context, I think it is appropriate to use an example name throughout: local
.
Same with FS90R
below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that, since the board name is used in configuring the servo but not in the code, that it's fine to keep this note in as a learning moment?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright that works. I'm just trying to avoid this kind of language:
"this value you entered does not matter"
"but it's important at an unspecified later date, don't forget"
Goal: names are up to you! But for this specific tutorial, use this one in particular
Actual: an aside about naming not mattering in the middle of actionable steps.
Feel free to retain if you find it helpful, I find it potentially convoluting!
Co-authored-by: andf-viam <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Recent changes still LGTM!
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/d4e417945f804c54f0732d1680c6bd8fe8bc95ec/public |
No description provided.