mirror of
https://github.com/kvcache-ai/sglang.git
synced 2026-07-18 01:37:57 +00:00
a3291b5654
Co-authored-by: AdityaVKochar <adityavardhankochar@gmail.com> Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: adhyan-jain <adhyanjain2006@gmail.com> Co-authored-by: Adhyan Jain <71976554+adhyan-jain@users.noreply.github.com> Co-authored-by: Maitri-shah29 <maitrirajivshah@gmail.com> Co-authored-by: Adarsh Shirawalmath <114558126+adarshxs@users.noreply.github.com> Co-authored-by: Maitri Shah <shah29maitri@gmail.com> Co-authored-by: Aditya Vardhan Kochar <80113212+AdityaVKochar@users.noreply.github.com> Co-authored-by: Rishit Shivam <164783543+pokymono@users.noreply.github.com> Co-authored-by: Rishitshivam <164783543+Rishitshivam@users.noreply.github.com> Co-authored-by: IshhanKheria <ishhankheria06@gmail.com> Co-authored-by: Ishita Joshi <ishitata.joshi@gmail.com> Co-authored-by: Richard Chen <104477092+Richardczl98@users.noreply.github.com> Co-authored-by: longGGGGGG <553746008@qq.com> Co-authored-by: Richard <richardchen@radixark.ai> Co-authored-by: Nakul Sinha <nakul.new4socials@gmail.com> Co-authored-by: Divyam Agrawal <ludicrouslytrue@gmail.com> Co-authored-by: Richardczl98 <Zhenlinc@stanford.edu> Co-authored-by: Krishang Zinzuwadia <krishangzinzuwadia@gmail.com> Co-authored-by: nimeshas <nimesha.s106@gmail.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Jignas Paturu <86356085+JignasP@users.noreply.github.com> Co-authored-by: zijiexia <37504505+zijiexia@users.noreply.github.com>
35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
> **Customize this file**: Tailor this template to your project by noting specific contribution types you're looking for, adding a Code of Conduct, or adjusting the writing guidelines to match your style.
|
|
|
|
# Contribute to the documentation
|
|
|
|
Thank you for your interest in contributing to our documentation! This guide will help you get started.
|
|
|
|
## How to contribute
|
|
|
|
### Option 1: Edit directly on GitHub
|
|
|
|
1. Navigate to the page you want to edit
|
|
2. Click the "Edit this file" button (the pencil icon)
|
|
3. Make your changes and submit a pull request
|
|
|
|
### Option 2: Local development
|
|
|
|
1. Fork and clone this repository
|
|
2. Install the Mintlify CLI: `npm i -g mint`
|
|
3. Create a branch for your changes
|
|
4. Make changes
|
|
5. Run `mint dev`
|
|
6. Preview your changes at `http://localhost:3000`
|
|
7. Commit your changes and submit a pull request
|
|
|
|
For more details on local development, see our [development guide](development.mdx).
|
|
|
|
## Writing guidelines
|
|
|
|
- **Use active voice**: "Run the command" not "The command should be run"
|
|
- **Address the reader directly**: Use "you" instead of "the user"
|
|
- **Keep sentences concise**: Aim for one idea per sentence
|
|
- **Lead with the goal**: Start instructions with what the user wants to accomplish
|
|
- **Use consistent terminology**: Don't alternate between synonyms for the same concept
|
|
- **Include examples**: Show, don't just tell
|