Skip to content

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

Open
wants to merge 16 commits into
base: dev
Choose a base branch
from

Conversation

azaleacolburn
Copy link
Contributor

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

  • No spelling/grammar mistakes
  • Documentation is accurate
  • Documentation is well-written and direct.

Before merging, ensure the following criteria are met:

  • All acceptance criteria outlined in the ticket are met.
  • Necessary test cases have been added and updated.
  • A feature toggle or safe disable path has been added (if applicable).
  • User-facing polish:
    • Ask: "Is this ready-looking?"
  • Cross-linking between Jira and GitHub:
    • PR links to the relevant Jira issue.
    • Jira ticket has a comment referencing this PR.

@azaleacolburn azaleacolburn self-assigned this Aug 19, 2025
@azaleacolburn azaleacolburn force-pushed the colbura/2027/documentation-updates branch from 7a26ee9 to f27f7da Compare August 19, 2025 15:32
@azaleacolburn azaleacolburn marked this pull request as ready for review August 19, 2025 17:20
@azaleacolburn azaleacolburn requested review from a team as code owners August 19, 2025 17:20
Copy link
Member

@AlexD717 AlexD717 left a 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

@azaleacolburn azaleacolburn requested a review from AlexD717 August 19, 2025 18:26
Copy link
Member

@rutmanz rutmanz left a 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wdym mostly

Copy link
Contributor Author

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.
Copy link
Member

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

Copy link
Contributor Author

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

Copy link
Member

@rutmanz rutmanz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong button

ryanzhangofficial

This comment was marked as off-topic.

@azaleacolburn azaleacolburn force-pushed the colbura/2027/documentation-updates branch from bfa7039 to 9c07fd3 Compare August 21, 2025 15:46
@rutmanz rutmanz changed the title Documentation Updates Documentation Updates [AARD-2027] Aug 21, 2025
Copy link
Member

@ryanzhangofficial ryanzhangofficial left a 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.

Copy link
Member

@AlexD717 AlexD717 left a 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

Copy link
Member

@BrandonPacewic BrandonPacewic left a 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.

@azaleacolburn azaleacolburn force-pushed the colbura/2027/documentation-updates branch from fd4c424 to 5f3b1be Compare August 21, 2025 22:27
@azaleacolburn azaleacolburn force-pushed the colbura/2027/documentation-updates branch from b8fc682 to d5af4ff Compare August 21, 2025 23:33
@azaleacolburn azaleacolburn requested a review from rutmanz August 22, 2025 17:47
Co-authored-by: Zach Rutman <[email protected]>
@azaleacolburn azaleacolburn requested a review from rutmanz August 22, 2025 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants