[doc] Convert ray-contribute getting-involved, development, and involvement to MyST#64136
[doc] Convert ray-contribute getting-involved, development, and involvement to MyST#64136dstrodtman wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Code Review
This pull request converts several documentation files (development, getting-involved, and involvement) from reStructuredText (.rst) to MyST Markdown (.md) and updates all corresponding references across the repository. The review feedback suggests minor improvements to the newly created Markdown files, specifically correcting a duplicate word typo in involvement.md and using relative anchor links instead of hardcoded .html extensions for self-referential links in getting-involved.md.
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.
| researchers, and folks that love machine learning. Here's a list of tips for getting involved with the Ray community: | ||
|
|
||
| - Join our [community Slack](https://www.ray.io/join-slack) to discuss Ray! | ||
| - Star and follow us on [on GitHub](https://github.com/ray-project/ray). |
There was a problem hiding this comment.
| git pull . upstream/master | ||
| ``` | ||
|
|
||
| 2. Make sure all existing [tests](getting-involved.html#testing) and [linters](getting-involved.html#lint-and-formatting) pass. |
There was a problem hiding this comment.
Since this link is self-referential to the same page, you can use relative anchor links (#testing and #lint-and-formatting) instead of hardcoding the .html filename extension.
| 2. Make sure all existing [tests](getting-involved.html#testing) and [linters](getting-involved.html#lint-and-formatting) pass. | |
| 2. Make sure all existing [tests](#testing) and [linters](#lint-and-formatting) pass. |
ffaa723 to
ce97049
Compare
…vement to MyST
## Why
`doc/.claude/CLAUDE.md` declares MyST Markdown the standard for new doc
pages, and a lint check rejects newly added `.rst`. This completes the
`ray-contribute/` migration with the hub/entry pages — the most coupled
ones, with sphinx-design tabs/dropdowns, includes, and `.claude/` path
references.
## What
Convert the final three Developer Guides pages from reStructuredText to
MyST Markdown, matching the conventions in `docs.md` / `agent-development.md`:
- `getting-involved` (the contributor hub)
- `development` (building Ray from source)
- `involvement` (the community-links partial included by `getting-involved`)
Faithful format conversion only, no content restructuring. Notable handling:
- `development`'s sphinx-design `.. tab-set::`/`.. tab-item::` and two
`.. dropdown::` blocks become colon-fence directives (`::::{tab-set}` /
`:::{tab-item}` / `:::{dropdown}`) so the nested code fences compose
cleanly. All 8 labels are preserved (`building-ray`, `fork-ray-repo`,
`prepare-venv`, `python-develop`, `python-develop-uninstall`,
`build-distributable-wheel`, `build-ray-image`, `full-source-build`) —
referenced internally and from `getting-involved`.
- `getting-involved`'s two `.. testcode::` blocks (the canonical pydoc
examples) become `{testcode}`; the page stays excluded from the doctest
rule, so its `doc/BUILD.bazel` exclude entry is updated `.rst` → `.md`.
Its `.. include::` of `involvement` becomes `{include} involvement.md`,
and the shared `_includes/_latest_contribution_doc.rst` banner stays an
include via `{include}` with `:parser: rst`.
- `involvement` is a content partial (no frontmatter); its named-reference
links are inlined, which also removes the duplicate `on GitHub` target it
shared with `getting-involved`.
Companion `.claude/` updates point at the new `.md` paths (root `CLAUDE.md`,
the `lint` and `rebuild` skills, the python-guidelines rule). Toctree entries
are extensionless and unchanged; `.html` redirect targets are unaffected.
One forced rendering change: the lettered sub-list (a/b/c) under "Fork the Ray
repository" becomes a numbered sub-list (1/2/3), since MyST/CommonMark has no
alpha-enumerated lists.
Signed-off-by: Douglas Strodtman <douglas@anyscale.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ce97049 to
abab74c
Compare
Description
Convert the final three contributor-facing Developer Guides pages in
doc/source/ray-contribute/from reStructuredText to MyST Markdown, completing the section's migration to MyST (the declared standard for new pages). These are the hub/entry pages — the most coupled in the section.Pages converted:
getting-involved— the contributor hubdevelopment— building Ray from sourceinvolvement— the community-links partial included bygetting-involvedFaithful format conversion only — no content restructuring. Notable handling:
development— the sphinx-design.. tab-set::/.. tab-item::and two.. dropdown::blocks become colon-fence directives (::::{tab-set}/:::{tab-item}/:::{dropdown}) so the nested code fences compose cleanly. All 8 cross-reference labels are preserved (building-ray,fork-ray-repo,prepare-venv,python-develop,python-develop-uninstall,build-distributable-wheel,build-ray-image,full-source-build) — referenced internally and fromgetting-involved.getting-involved— its two.. testcode::blocks (the canonical pydoc examples) become{testcode}; the page stays excluded from the doctest rule, so itsdoc/BUILD.bazelexclude entry is updated.rst→.md. The.. include::ofinvolvementbecomes{include} involvement.md, and the shared_includes/_latest_contribution_doc.rstbanner stays an include via{include}with:parser: rst. Thegetting-involvedlabel is preserved.involvement— a content partial (no frontmatter); its named-reference links are inlined, which also removes the duplicateon GitHubtarget it shared withgetting-involved.Companion
.claude/updates point at the new.mdpaths (rootCLAUDE.md, thelintandrebuildskills, the python-guidelines rule). Toctree entries are extensionless and unchanged;.htmlredirect targets are unaffected.One forced rendering change: the lettered sub-list (a/b/c) under "Fork the Ray repository" becomes a numbered sub-list (1/2/3), since MyST/CommonMark has no alpha-enumerated lists.
Related issues
None.
Additional information
Verified locally: frontmatter parses; backtick and
:::colon fences balance (60/60 and 10/10); all 9 labels present;{testcode}/{toctree}/{include}/{tab-set}/{tab-item}/{dropdown}counts are exact; no residual RST outside fences; and the blockquote-wrapped code, the Windows nested numbered list, and the python-develop column-0 code-block list all render correctly via markdown-it. The RtD preview build is the authoritative check for the sphinx-design directives and cross-references.Completes the
ray-contribute/RST→MyST migration (Tier A #64100, Tier B #64111, Tier C #64115, plus therst-to-mystskill #64135).Cross-reference fixes (flagged by the initial RtD build):
docs.md's link to the renamedgetting-involvedis now extensionless, andgetting-involved's two intra-page section links use MyST#anchorfragments — the original.html#anchorform isn't resolved by MyST and emitsmyst.xref_missing.