Skip to content

[Docs] Style and grammar pass on ray-contribute developer guides#64280

Merged
elliot-barn merged 4 commits into
ray-project:masterfrom
dstrodtman:djs-260623-ray-contribute-style
Jul 2, 2026
Merged

[Docs] Style and grammar pass on ray-contribute developer guides#64280
elliot-barn merged 4 commits into
ray-project:masterfrom
dstrodtman:djs-260623-ray-contribute-style

Conversation

@dstrodtman

Copy link
Copy Markdown
Contributor

Summary

A style and grammar editing pass across all pages in doc/source/ray-contribute/ (the developer and contributor guides). This is a copyedit only — no content, instructions, or behavior change.

What changed

  • Headings: sentence case, preserving proper nouns and acronyms (Ray, API, CI, GDB, Docker).
  • Word choice: removed filler (simply/just/actually/currently/easily); "such as" instead of "like" for examples; spelled out "for example"/"that is" for Latin abbreviations.
  • Voice and tense: active voice and present tense where the actor is clear; kept the project's first-person "we" voice.
  • Punctuation: removed em-dashes, semicolons, and parenthetical asides in prose; restructured into shorter sentences; straightened curly quotes.
  • Links and images: descriptive link text (no bare URLs or "click here"); added alt text to images.
  • Fixes: typos and errors including non-determnisticnon-deterministic, .rST.rst, "an usage" → "a usage", "twice cheaper" → "at half the cost", Mac OS/MacOS/MacbookmacOS/MacBook.

Safety

  • MyST directives, {ref}/{doc} roles, (label)= anchors, front matter, and all code and output blocks are untouched. Verified: role and label counts are identical to master, and no internal anchor links reference reworded headings.
  • Vale (Google style, the linter CI uses) alerts drop from 344 errors / 176 suggestions to 270 / 123. The remaining errors are pre-existing Vale.Spelling false positives on domain terms such as Bazel, pytest, and raylet.

15 files changed.

🤖 Generated with Claude Code

Copyedit pass across doc/source/ray-contribute with no content or behavior
changes:

- Sentence-case headings (proper nouns and acronyms preserved).
- Remove filler (simply/just/actually/currently/easily); "such as" not
  "like"; spell out "for example"/"that is" for e.g./i.e.
- Active voice and present tense where the actor is clear; keep the
  project's first-person "we" voice.
- Remove em-dashes, semicolons, and parenthetical asides; restructure into
  shorter sentences; straighten curly quotes.
- Descriptive link text (no bare URLs or "click here"); image alt text.
- Fix typos and errors: non-determnistic, .rST, "an usage", "twice cheaper",
  Mac OS/MacOS/Macbook -> macOS/MacBook.

MyST directives, {ref}/{doc} roles, (label)= anchors, and code blocks are
untouched. Vale (Google style) alerts drop from 344 errors / 176 suggestions
to 270 / 123.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Douglas Strodtman <douglas@anyscale.com>
@dstrodtman dstrodtman requested a review from a team as a code owner June 23, 2026 15:53

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request makes extensive copyediting, formatting, and stylistic improvements across Ray's contributor and developer documentation to enhance readability and consistency. The changes include standardizing title capitalization to sentence case, correcting typos, improving grammar, and updating terminology. The review feedback suggests replacing several absolute URLs pointing to the master branch with local MyST cross-references ({doc} and {ref}) and relative links to ensure they resolve correctly in local previews and across different branches.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread doc/source/ray-contribute/development.md Outdated
Comment thread doc/source/ray-contribute/docs.md Outdated
Comment thread doc/source/ray-contribute/docs.md Outdated
dstrodtman and others added 2 commits June 23, 2026 12:15
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Douglas Strodtman <douglas@anyscale.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Douglas Strodtman <douglas@anyscale.com>
@ray-gardener ray-gardener Bot added docs An issue or change related to documentation core Issues that should be addressed in Ray Core labels Jun 23, 2026
@dstrodtman dstrodtman added the go add ONLY when ready to merge, run all tests label Jun 24, 2026
Signed-off-by: Douglas Strodtman <douglas@anyscale.com>
@dstrodtman dstrodtman requested a review from a team as a code owner July 2, 2026 16:05
@elliot-barn elliot-barn merged commit 9a6e905 into ray-project:master Jul 2, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Issues that should be addressed in Ray Core docs An issue or change related to documentation go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants