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.

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

[Docs] Update Readme on project intro #191

Merged
merged 2 commits into from
Sep 19, 2024
Merged

[Docs] Update Readme on project intro #191

merged 2 commits into from
Sep 19, 2024

Conversation

xieus
Copy link
Collaborator

@xieus xieus commented Sep 19, 2024

Pull Request Description

Update Readme on project introduction

Important: Before submitting, please complete the description above and review the checklist below.


Contribution Guidelines (Expand for Details)

We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:

Pull Request Title Format

Your PR title should start with one of these prefixes to indicate the nature of the change:

  • [Bug]: Corrections to existing functionality
  • [CI]: Changes to build process or CI pipeline
  • [Docs]: Updates or additions to documentation
  • [API]: Modifications to aibrix's API or interface
  • [CLI]: Changes or additions to the Command Line Interface
  • [Misc]: For changes not covered above (use sparingly)

Note: For changes spanning multiple categories, use multiple prefixes in order of importance.

Submission Checklist

  • PR title includes appropriate prefix(es)
  • Changes are clearly explained in the PR description
  • New and existing tests pass successfully
  • Code adheres to project style and best practices
  • Documentation updated to reflect changes (if applicable)
  • Thorough testing completed, no regressions introduced

By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.

@xieus xieus requested a review from Jeffwan September 19, 2024 05:33
@Jeffwan
Copy link
Collaborator

Jeffwan commented Sep 19, 2024

This is great! Please also help sync the content to this page https://github.com/aibrix/aibrix/blob/main/docs/source/index.rst

@Jeffwan Jeffwan added the kind/documentation Improvements or additions to documentation label Sep 19, 2024
@xieus
Copy link
Collaborator Author

xieus commented Sep 19, 2024

Sure. Updated the rst file and tested locally with the following tool. Let me know if there is any better tool.

pip install restview
restview index.rst

A html page will be displayed as follows:
image

@Jeffwan
Copy link
Collaborator

Jeffwan commented Sep 19, 2024

@xieus You can follow this instruction to launch the site. The change looks good to me

https://github.com/aibrix/aibrix/tree/main/docs

@Jeffwan Jeffwan merged commit e9ded81 into main Sep 19, 2024
7 checks passed
@Jeffwan Jeffwan deleted the xieus/update_readme branch September 19, 2024 17:15
gangmuk pushed a commit that referenced this pull request Jan 25, 2025
* Update Readme on project intro

* Update index.rst accordingly
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants