Documentation Updates [AARD-2027]
#1285
Conversation
azaleacolburn
force-pushed
the
colbura/2027/documentation-updates
branch
from
7a26ee9 to
f27f7da
Compare
azaleacolburn
requested review from
BrandonPacewic,
Dhruv-0-Arora,
PepperLola and
ryanzhangofficial
AlexD717
left a comment
AlexD717
left a comment
There was a problem hiding this comment.
Couple of minor grammar stuff
rutmanz
left a comment
rutmanz
left a comment
There was a problem hiding this comment.
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.
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.
if you're going to say mostly specify the exception imo
There was a problem hiding this comment.
I agree, I'll need to look into the simulation system to figure out what he meant
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
azaleacolburn
force-pushed
the
colbura/2027/documentation-updates
branch
from
bfa7039 to
9c07fd3
Compare
ryanzhangofficial
left a comment
ryanzhangofficial
left a comment
There was a problem hiding this comment.
Looks great! Just clarify the parts with "mostly" and it should be good to go.
BrandonPacewic
left a comment
BrandonPacewic
left a comment
There was a problem hiding this comment.
Some outright gammer changes that need to be made. Left one suggestion with a justification, feel free to make that edit or not.
azaleacolburn
force-pushed
the
colbura/2027/documentation-updates
branch
from
fd4c424 to
5f3b1be
Compare
azaleacolburn
force-pushed
the
colbura/2027/documentation-updates
branch
from
b8fc682 to
d5af4ff
Compare
Co-authored-by: Zach Rutman <zarutman+git@gmail.com>
* 'dev' of github.com:Autodesk/synthesis: (144 commits) fix: migrate biome config fix: remove prints fix: formatter and new SoundPlayer singleton fix: typing fix: focus and configuration fixes fix: format and lint fix: renamed field asset in test fix: tests pass now fix: ui appearance changes - updated main hud with new buttons, made button group - made modal colors consistent with panel - switched to using tabs instead of toggle button groups - fixed aps reload button disappearing on import panel reopen Scrollable Command Palette fix: make ci work No radius in text field top edges Disable Autocomplete fix: make robots reset to spawn positions in multiplayer Removed Useless Command & Black Border Register Commands Formatting Configure Assets Multiple Tabs fix(build): use moved hashBuffer chore: formatting pass 9 (reqs) ...
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: