[Doc] Copyedit dev guide #1012
Merged
[Doc] Copyedit dev guide #1012
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
Signed-off-by: Archit Kulkarni <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
kevin85421
approved these changes
Apr 5, 2023
There was a problem hiding this comment.
I do not check documents related to KubeRay APIServer and KubeRay CLI. Should we add some sentences in development.md to describe that some components are optional? I am concerned about the compatibility of some components because there have been very few code changes in the last six months. Others look good to me.
Signed-off-by: Archit Kulkarni <[email protected]>
kevin85421
approved these changes
Apr 5, 2023
|
This PR only updates docs. Merge this PR before CI passes. |
lowang-bh
pushed a commit
to lowang-bh/kuberay
that referenced
this pull request
Sep 24, 2023
Copyedit dev guide
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.
Why are these changes needed?
The current dev guide is accurate and concise, but there is room to improve clarity and readability, which is the aim of this PR. Note: I used GPT for the first copyediting pass and I reviewed it manually to ensure the changes were positive and the underlying meaning did not change.
Related issue number
Checks