Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[RLlib; docs] Docs do-over (new API stack): RLlib README.rst; simply link to main index page. #49399

Merged
merged 3 commits into from
Dec 30, 2024
Merged

[RLlib; docs] Docs do-over (new API stack): RLlib README.rst; simply link to main index page. #49399

merged 3 commits into from
Dec 30, 2024

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Dec 21, 2024 •
edited
Loading

Docs do-over (new API stack):

  • RLlib README.rst should mimic main RLlib index page.
  • Fix RLlib paper citations.
  • Fix all vale errors/suggestions.

Why are these changes needed?

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@sven1977 sven1977 added rllib RLlib related issues rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack labels Dec 21, 2024
@sven1977 sven1977 added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Dec 27, 2024
@sven1977 sven1977 enabled auto-merge (squash) December 27, 2024 14:43
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Dec 27, 2024
@github-actions github-actions bot disabled auto-merge December 27, 2024 20:24
simonsays1980
simonsays1980 approved these changes Dec 30, 2024
View reviewed changes
Copy link
Collaborator

@simonsays1980 simonsays1980 left a comment

Choose a reason for hiding this comment

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

LGTM.

@sven1977 sven1977 merged commit ddee378 into ray-project:master Dec 30, 2024
5 checks passed
@sven1977 sven1977 deleted the docs_redo_readme_rst_should_just_link_to_index branch December 30, 2024 12:14
srinathk10 pushed a commit that referenced this pull request Jan 3, 2025
@sven1977 @srinathk10
[RLlib; docs] Docs do-over (new API stack): RLlib README.rst; simply …
15cd58f 
…link to main index page. (#49399)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@simonsays1980 simonsays1980 simonsays1980 approved these changes

@maxpumperla maxpumperla Awaiting requested review from maxpumperla maxpumperla is a code owner

Assignees

@simonsays1980 simonsays1980

@angelinalg angelinalg

Labels
go add ONLY when ready to merge, run all tests rllib RLlib related issues rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack tests-ok The tagger certifies test failures are unrelated and assumes personal liability.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sven1977 @simonsays1980 @angelinalg