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

docs: improve the documentation framework. #203

Merged
merged 2 commits into from
Jan 19, 2024
Merged

docs: improve the documentation framework. #203

merged 2 commits into from
Jan 19, 2024

Conversation

zhouaihui
Copy link
Member

@zhouaihui zhouaihui commented Jan 19, 2024 •
edited
Loading

This will close #197.

  • Docs framework
  • Why RayFed
  • Quick start
  • Tutorials
  • API
  • Architecture of RayFed
  • Principle of RayFed

jovany-wang
jovany-wang approved these changes Jan 19, 2024
View reviewed changes
Copy link
Collaborator

@jovany-wang jovany-wang left a comment

Choose a reason for hiding this comment

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

LGTM

docs/source/advanced_topic/architecture.md Outdated Show resolved Hide resolved
@fengsp
Copy link
Collaborator

fengsp commented Jan 19, 2024

Maybe we should rename .md files to .rst

@zhouaihui zhouaihui merged commit 70d3cc8 into ray-project:main Jan 19, 2024
14 checks passed
@zhouaihui zhouaihui deleted the docs/doc_framework branch January 19, 2024 08:44
@zhouaihui
Copy link
Member Author

rst and md are all ok.
For me, markdown +1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jovany-wang jovany-wang jovany-wang approved these changes

@fengsp fengsp Awaiting requested review from fengsp

@NKcqx NKcqx Awaiting requested review from NKcqx

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add api docs.
3 participants
@zhouaihui @fengsp @jovany-wang