-
Notifications
You must be signed in to change notification settings - Fork 61
Documentation Updates [AARD-2027]
#1285
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
base: dev
Are you sure you want to change the base?
Conversation
7a26ee9
to
f27f7da
Compare
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.
Couple of minor grammar stuff
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.
It looks like a few things (like contact info) are duplicated across CONTRIBUTING.md and README.md (and say different things)
|
||
#### Driver | ||
|
||
Drivers are mostly write-only. They take in values to know how to articulate the physics objects and constraints. |
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.
wdym mostly
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 didn't write that, it was copy-pasted from the old fission readme, I'm not sure what Hunter meant by "mostly" either.
|
||
#### Stimulus | ||
|
||
Stimuli are mostly read-only. They read values from given physics objects and constraints. |
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.
if you're going to say mostly specify the exception imo
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 agree, I'll need to look into the simulation system to figure out what he meant
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.
wrong button
bfa7039
to
9c07fd3
Compare
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.
Looks great! Just clarify the parts with "mostly" and it should be good to go.
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.
Couple more grammar issues
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.
Some outright gammer changes that need to be made. Left one suggestion with a justification, feel free to make that edit or not.
fd4c424
to
5f3b1be
Compare
b8fc682
to
d5af4ff
Compare
Co-authored-by: Zach Rutman <[email protected]>
Task
AARD-2027
Symptom
Much of our documentation was out of date, unhelpful, or just poorly written.
Solution
This PR revises, rewrites, reformats nearly all of the documentation files in Synthesis. The goal of this PR is not to comprehensively document all of Synthesis—that should be done peace-meal—rather merely to make the documentation we have more accurate, readable, and robust.
Verification
Before merging, ensure the following criteria are met: