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

Reorganize docs/development and docs/tutorial structure #455

Merged
merged 2 commits into from
Dec 2, 2024

Conversation

Jeffwan
Copy link
Collaborator

@Jeffwan Jeffwan commented Dec 2, 2024

Pull Request Description

This is to move unrelated content from docs/ folder to other folders.

  • docs/development currently not only write development docs but also mocked app. mocked app should definitely be separate components instead of doc. Similarly, simulation tools etc should be separated.
  • docs/tutorial is not well organized in the past. It's kind of between internal and external. I decided to move to development/tutorials for internal dev focusing. For other GPU workloads, we should definitely move to ``

Related Issues

Resolves: #379

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.

@Jeffwan
Copy link
Collaborator Author

Jeffwan commented Dec 2, 2024

This is a doc structure refactor. I will skip the review and get this merged.

@Jeffwan Jeffwan merged commit 1a996e0 into main Dec 2, 2024
2 checks passed
@Jeffwan Jeffwan deleted the jiaxin/reorganize_doc_folder_structure branch December 2, 2024 04:40
gangmuk pushed a commit that referenced this pull request Jan 25, 2025
* Move docs/development to root folder

* Move docs/tutorials to development/tutorials
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move mocked app from docs/development folder to some other folders
1 participant