Skip to content
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 detailed documentation #9

Merged
merged 4 commits into from
Feb 12, 2023
Merged

Add detailed documentation #9

merged 4 commits into from
Feb 12, 2023

Conversation

boydgreenfield
Copy link
Contributor

@boydgreenfield boydgreenfield commented Oct 25, 2022

@Keats @GSGerritsen Would love your review here. Note there are a few outstanding items before I want to merge this, including:

  • I have another ~1-2 dozen edits based on paper markup I didn't quite get through last night (these are minor clarifications, changing examples for consistency/clarity, etc.)
  • Add example code details
  • Add space requirements for use cases
  • Clean up parameter selection notebook (should we commit this with rendered cells so it views more easily or not?)

I'll then tackle making sure our cargo docs are consistent in a separate PR (see #13) as well as adding more detailed benchmarking (#15).

Closes #12. Closes #14.

@boydgreenfield boydgreenfield force-pushed the boyd/add-release-docs branch 2 times, most recently from d6bb4ab to e748188 Compare February 2, 2023 19:31
@boydgreenfield boydgreenfield changed the title [WIP] Add detailed documents [WIP] Add detailed documentation Feb 2, 2023
@boydgreenfield boydgreenfield force-pushed the boyd/add-release-docs branch 2 times, most recently from fbe3ee7 to 11614dd Compare February 3, 2023 15:03
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@boydgreenfield boydgreenfield force-pushed the boyd/add-release-docs branch 3 times, most recently from 413506f to 4e2ac0d Compare February 12, 2023 02:01
@boydgreenfield boydgreenfield changed the title [WIP] Add detailed documentation Add detailed documentation Feb 12, 2023
@boydgreenfield
Copy link
Contributor Author

FYI rebasing this for cleanliness. Commits post your comments @Keats @GSGerritsen are on this branch in case you want to look at them (I'll delete in a few days).

Tests pass and this doesn't change any APIs or functionality, so I'm going to merge once cleaned up!

@boydgreenfield boydgreenfield merged commit d19f976 into master Feb 12, 2023
@boydgreenfield boydgreenfield deleted the boyd/add-release-docs branch February 12, 2023 02:11
@boydgreenfield
Copy link
Contributor Author

🤦‍♂️ I updated our primary branch to main but didn't update this PR, so just merged it against master (which I hadn't deleted yet). Oops. Re-opening.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants