Internal dev README (potentially user-facing README) #205
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dbogunowicz
requested review from
bfineran,
anmarques,
a team and
corey-nm
and removed request for
a team
dbogunowicz
changed the title
|
@dbogunowicz what's the plan with this doc? still want to merge or no? |
|
@corey-nm absolutely. It ended up in limbo, waiting for reviews. Let me ping the rest of the team to decide how to complete this PR. |
bfineran
previously approved these changes
Sep 27, 2022
KSGulin
previously approved these changes
Sep 27, 2022
dbogunowicz
dismissed stale reviews from KSGulin, bfineran, and corey-nm
via
9985434
dbogunowicz
commented
Sep 27, 2022
dbogunowicz
commented
Sep 27, 2022
dbogunowicz
commented
Sep 27, 2022
dbogunowicz
commented
Sep 27, 2022
dbogunowicz
commented
Sep 27, 2022
dbogunowicz
requested review from
jeanniefinks
and removed request for
anmarques
|
Revisited the PR, fused my write-up with the repositories README.md, added some missing features to the documentation, and tested all the pathways. |
jeanniefinks
previously requested changes
Sep 27, 2022
Co-authored-by: Jeannie Finks <74554921+jeanniefinks@users.noreply.github.com>
dbogunowicz
commented
Sep 27, 2022
corey-nm
approved these changes
Sep 28, 2022
markurtz
approved these changes
Oct 5, 2022
There was a problem hiding this comment.
@dbogunowicz can we get this cherry picked over to 1.2 as well?
|
@markurtz for sure |
dbogunowicz
dismissed
jeanniefinks’s stale review
Want to merge and cherry pick it before release. I took all Jeannie's comments into consideration.
dbogunowicz
added a commit
that referenced
this pull request
Oct 6, 2022
* initial commit * merge readmes * just need grammar and consistency review * Apply suggestions from code review * Update README.md Co-authored-by: Jeannie Finks <74554921+jeanniefinks@users.noreply.github.com> * Update README.md Co-authored-by: bogunowicz@arrival.com <bogunowicz@arrival.com> Co-authored-by: Jeannie Finks <74554921+jeanniefinks@users.noreply.github.com>
dbogunowicz
added a commit
that referenced
this pull request
Oct 6, 2022
* initial commit * merge readmes * just need grammar and consistency review * Apply suggestions from code review * Update README.md Co-authored-by: Jeannie Finks <74554921+jeanniefinks@users.noreply.github.com> * Update README.md Co-authored-by: bogunowicz@arrival.com <bogunowicz@arrival.com> Co-authored-by: Jeannie Finks <74554921+jeanniefinks@users.noreply.github.com>
dbogunowicz
added a commit
that referenced
this pull request
Oct 6, 2022
* initial commit * merge readmes * just need grammar and consistency review * Apply suggestions from code review * Update README.md Co-authored-by: Jeannie Finks <74554921+jeanniefinks@users.noreply.github.com> * Update README.md Co-authored-by: bogunowicz@arrival.com <bogunowicz@arrival.com> Co-authored-by: Jeannie Finks <74554921+jeanniefinks@users.noreply.github.com>
dbogunowicz
added a commit
that referenced
this pull request
Oct 6, 2022
) * Internal dev README (potentially user-facing README) (#205) * initial commit * merge readmes * just need grammar and consistency review * Apply suggestions from code review * Update README.md Co-authored-by: Jeannie Finks <74554921+jeanniefinks@users.noreply.github.com> * Update README.md Co-authored-by: bogunowicz@arrival.com <bogunowicz@arrival.com> Co-authored-by: Jeannie Finks <74554921+jeanniefinks@users.noreply.github.com> * Internal dev README (potentially user-facing README) (#205) * initial commit * merge readmes * just need grammar and consistency review * Apply suggestions from code review * Update README.md Co-authored-by: Jeannie Finks <74554921+jeanniefinks@users.noreply.github.com> * Update README.md Co-authored-by: bogunowicz@arrival.com <bogunowicz@arrival.com> Co-authored-by: Jeannie Finks <74554921+jeanniefinks@users.noreply.github.com> Co-authored-by: bogunowicz@arrival.com <bogunowicz@arrival.com> Co-authored-by: Jeannie Finks <74554921+jeanniefinks@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A simple guide to using the new sparsezoo.
I would like this document to end up as a part of our user-facing docs. Let's discuss what properties this would need to have to be as useful as possible for our users.