[Docs] Add path-chooser, fix cross-references, and reorganize tips#61501
Merged
[Docs] Add path-chooser, fix cross-references, and reorganize tips#61501
Conversation
Contributor
Author
Contributor
Author
|
This was referenced Mar 4, 2026
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request improves the development setup documentation by reorganizing content, adding a 'path-chooser' list for different build types, and replacing vague phrases with specific cross-references. My review identifies a minor inconsistency in the cross-referencing style and a point of ambiguity in a new tip that could be clarified to prevent user error.
andrew-anyscale
force-pushed
the
andrew/revup/master/add-refs
branch
from
7a39e95 to
2b82c0b
Compare
andrew-anyscale
force-pushed
the
andrew/revup/master/update-wheel-docs
branch
2 times, most recently
from
06399c7 to
bd2a749
Compare
andrew-anyscale
force-pushed
the
andrew/revup/master/add-refs
branch
2 times, most recently
from
9e5f42c to
7a51cf6
Compare
- Remove combined opening tip (Python-only and Full build hints) - Add path-chooser list at the top to direct readers to Python-only or full source build paths - Replace "as explained/described above" prose with :ref: cross-references to fork-ray-repo and prepare-venv labels - Move "if you already followed python-develop..." hint into a tip inside the Full Source Build section Topic: add-refs Relative: update-wheel-docs Signed-off-by: andrew <andrew@anyscale.com>
andrew-anyscale
force-pushed
the
andrew/revup/master/add-refs
branch
from
7a51cf6 to
87b91a3
Compare
Contributor
Author
|
Conflicts resolved |
Apply Google developer documentation style guide rules to
development.rst:
- Sentence case: fix 11 headings (Source, Steps, Only, Full Source
Build, MacOS, Development Tooling, Pre-commit Hooks, Advanced Build
Options, Fast/Debug/Optimized Builds, Building the Docs)
- Second person: replace "We provide" with "Use the script"
- Present tense: replace future "will" constructions throughout (env var
list, prose sections)
- Contractions: "Do not" -> "Don't", "will not" -> "won't", "pip is not"
-> "isn't"
- Active voice: env var list passive constructions converted ("will be
built" -> "Ray builds", etc.)
- macOS branding: fix "MacOS" -> "macOS" and "mac" -> "Mac" throughout
Signed-off-by: andrew <andrew@anyscale.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
full source build paths
to fork-ray-repo and prepare-venv labels
the Full Source Build section
Topic: add-refs
Relative: update-wheel-docs
Signed-off-by: andrew andrew@anyscale.com