-
Notifications
You must be signed in to change notification settings - Fork 266
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
Add doc for roboRIO safety controls #2265
Conversation
Could you clarify the original post the article is from? So, there's a couple of issues I have with the content as-is that prevents me from merging this in it's current form.
This article should get rewritten to be more than an information dump, with a clear direction on what value we are trying to provide to the reader (how Netcomm and motor controller heartbeat work, and how to identify user failures). |
Thanks. Peter's information is correct, but is not written in a way that makes sense to a reader just visiting that webpage. The article needs context and a value-purpose (what are we trying to solve) that guides language and direction. |
Like you said, this is a very large amount of information. I'm not even sure where to start with this. IMHO, this is just meant to be an informative article, something similar to A Technical Discussion on C++ Commands. I don't know if there's really any other purpose for it, except the last part about delayed disabling. Perhaps that could be extracted into a troubleshooting article, like avoiding running anything else other the DS, although that could just go into DS Best Practices. |
A Technical Discussion on C++ Commands works because it has a purpose. To inform the reader of the design decision for Commandsv2 and the context behind those decisions. The context is what makes the article work and provides a lot of value. That article provides context by identifying problems in the original command based, and possible solutions. It then iterates on how to make this a viable API for the consumer. It constantly reflects its context onto the reader, which is important to a well-written article. This article should ideally be written (this is just me throwing out a suggestion, but I'm totally open to other ideas) in a form like following.
|
Fixes #2227. Slight adjustments from the original post for grammar, removal of non-ASCII characters, and use of markup.