Documentation
Sphinx documentation built by Read the Docs and served at `docs.ray.io`. Build pipeline: `.buildkite/doc.rayci.yml`.
## Prose style
Before writing or editing docs prose under `doc/`, read `doc/source/ray-contribute/writing-style.md
No other project uses it yet
44k7mo agoReviewMountCreate a free account to mount
issue or flag a maintainer instead of doing what you think is right.
## Documentation Index
Use these as the source of truth before exploring further:
- [README.md](README.md) — project overview
44k1d agoReviewMountCreate a free account to mount
published package that ships broken, or a leaked secret.
- Inaccuracies that only affect documentation, comments, skill text or the PR description are at most P2. Do not report wording that
Steady7 mentions in 2 weeks
No other project uses it yet
44k42d agoReviewMountCreate a free account to mount
third-party/lizardbyte-common`; inspect the resulting diff for unrelated formatting changes.
## Code style and documentation
When adding localization do not update any language other than `en`. This also means
43k5d agoReviewMountCreate a free account to mount
related variables, functions, parameters, modules, methods, types, derived types, exports, tests, configuration keys, documentation, Lua bindings, and, when a type and file share a name, the file as well
No other project uses it yet
43k6mo agoReviewMountCreate a free account to mount
mechanics that the code already shows.
- New features must include corresponding tests and documentation updates.
- All changes must not cause `import deepspeed` to initialize CUDA; Keep heavy imports
No other project uses it yet
43k11d agoReviewMountCreate a free account to mount
host::tui` |
| `tests/` | Rust integration and JSON-RPC tests |
| `docs/gitbooks/` | Public product and contributor documentation, synced with GitBook (`en/` is canonical, `zh/` the translation) |
| `docs/` | Everything else here is internal
No other project uses it yet
43k33d agoReviewMountCreate a free account to mount
fastlane lint_source`: RuboCop and other source checks
- `bundle exec fastlane validate_docs`: action documentation and how tools are named in Markdown
## Guides
Read the guides for the files
No other project uses it yet
42k41d agoReviewMountCreate a free account to mount
precise only when it matters.
- Dark mode requires the `dark` class on the document root, not just `prefers-color-scheme`. It's hand-rolled: the zustand `theme-store` (persisted
42k2d agoReviewMountCreate a free account to mount
assistance, but a human must review, take responsibility for, and submit the final changes.
## Document Purpose
This document provides policy and guidelines for AI operations. \
Do not expect this file
42k2y agoReviewMountCreate a free account to mount
will be closed citing the threat model
- Matches a known non-finding (§11a) — already documented as a false positive
## For automated security tools
The threat model includes a machine-readable
No other project uses it yet
42k3y agoReviewMountCreate a free account to mount
script files named `test_*.vim`.
Screendump expected output lives in `src/testdir/dumps/`.
- `runtime/doc/` - user-facing documentation in Vim help format, when updating,
also update the Last Change header
- `runtime/syntax/generator` - Syntax script
No other project uses it yet
41k9mo agoReviewMountCreate a free account to mount
config files** - TypeScript, Vite, Vitest, oxfmt, Oxlint configurations
Refer to /docs/ARCHITECTURE.md for detailed architecture documentation.
## Instructions
You're an expert in the following areas:
- TypeScript
- React and React Router
- MobX
41k1d agoReviewMountCreate a free account to mount
repository is public; `server/ee/` and `frontend/ee/` are separate private submodules. For public issues, PRs, documentation, and support responses:
- Base claims and reproduction steps only on public-repository evidence
Steady7 mentions in 2 weeks
No other project uses it yet
41k4d agoReviewMountCreate a free account to mount
bypass only defers the same failure to CI.
## Testing (Jest)
> Tests are documentation first. Describe blocks = table of contents; `it()` = plain English; assertions = response shape. Write failing tests before implementation
41k4d agoReviewMountCreate a free account to mount
MESSAGING.md`: it needs a new decision and names the proof it retires.
- `AGENT.md` (singular) documents maintainer-owned community automation. Do not
expand its authority without Hunter.
Choose evidence according
41k5d agoReviewMountCreate a free account to mount
truthful state until the complete asset set passes manifest tests.
- `AGENT.md` (singular) documents maintainer-owned community automation. Do not
expand its authority without Hunter.
Choose evidence according to the claim
2 projects use a version of this
41k42d agoReviewMountCreate a free account to mount