Docs: Update documentation workflow and contribution guide (#2704)

Co-authored-by: Chayenne <zhaochen20@outlook.com>

docs/README.md

@@ -1,35 +1,77 @@
 # SGLang Documentation
-This is the documentation repository for SGLang. It is auto-generated from https://github.com/sgl-project/sglang/tree/main/docs.
+We recommend new contributors start from writing documentation, which helps you quickly understand SGLang codebase. Most documentation files are located under the `docs/` folder. We prefer **Jupyter Notebooks** over Markdown so that all examples can be executed and validated by our docs CI pipeline.
 
-## Build the documentation website
+## Docs Workflow
 
-### Dependency
-```
+### Install Dependency
+
+```bash
 pip install -r requirements.txt
 ```
 
-### Build
-```
-make html
-```
+### Update Documentation
 
-### Clean
-To remove all generated files:
-```
-make clean
-```
+Update your Jupyter notebooks in the appropriate subdirectories under `docs/`. If you add new files, remember to update `index.rst` (or relevant `.rst` files) accordingly.
 
-### Serve (preview)
-Run an HTTP server and visit http://localhost:8000 in your browser.
-
-```
-python3 -m http.server --d _build/html
-```
-
-### Deploy
-Clone [sgl-project.github.io](https://github.com/sgl-project/sgl-project.github.io) and make sure you have write access.
+- **`pre-commit run --all-files`** manually runs all configured checks, applying fixes if possible. If it fails the first time, re-run it to ensure lint errors are fully resolved. Make sure your code passes all checks **before** creating a Pull Request.
+- **Do not commit** directly to the `main` branch. Always create a new branch (e.g., `feature/my-new-feature`), push your changes, and open a PR from that branch.
 
 ```bash
-export DOC_SITE_PATH=../../sgl-project.github.io   # update this with your path
-python3 deploy.py
+# 1) Compile all Jupyter notebooks
+make compile
+
+# 2) Generate static HTML
+make html
+
+# 3) Preview documentation locally
+# Open your browser at the displayed port to view the docs
+bash serve.sh
+
+# 4) Clean notebook outputs
+# nbstripout removes notebook outputs so your PR stays clean
+pip install nbstripout
+find . -name '*.ipynb' -exec nbstripout {} \;
+
+# 5) Pre-commit checks and create a PR
+# After these checks pass, push your changes and open a PR on your branch
+pre-commit run --all-files
+```
+
+
+If you need to run and shut down a SGLang server or engine, following these examples:
+
+1. Launch and close Sever:
+
+```python
+#Launch Sever
+
+from sglang.utils import (
+    execute_shell_command,
+    wait_for_server,
+    terminate_process,
+    print_highlight,
+)
+
+server_process = execute_shell_command(
+    "python -m sglang.launch_server --model-path meta-llama/Meta-Llama-3.1-8B-Instruct --port 30000 --host 0.0.0.0"
+)
+
+wait_for_server("http://localhost:30000")
+
+# Terminate Sever
+
+terminate_process(server_process)
+```
+2. Launch Engine and close Engine
+
+```python
+# Launch Engine
+
+import sglang as sgl
+import asyncio
+
+llm = sgl.Engine(model_path="meta-llama/Meta-Llama-3.1-8B-Instruct")
+
+# Terminalte Engine
+llm.shutdown()
 ```