[Docs] Update README.md MkDocs to give option to run dev-server on different port. (#54584)
Signed-off-by: jcayab <42927334+jcayab@users.noreply.github.com> Signed-off-by: Jefrey Cayab <jcayab@gmail.com> Signed-off-by: Jefrey Cayab <42927334+jcayab@users.noreply.github.com> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Jefrey Cayab committed
Sep 9, 2026 at 17:08 UTC
de650b55af53d7fd1677cc0cbaa0fad97b78286e
2 files changed
+6
-3
docs/contributing/README.md
+3
-3
@@ -120,15 +120,15 @@ uv pip install -r requirements/docs.txt
120
(e.g., `mkdocs-awesome-nav` requires Python 3.10+)
121
122
MkDocs comes with a built-in dev-server that lets you preview your documentation as you work on it.
123
-From the root of the repository, run:
123
+From the root of the repository, run the following. Note that by default, the dev-server will run on `127.0.0.1:8000`. Should you want to run the dev-server on a different port, use `-a` like this `mkdocs serve -a localhost:8090`.
124
125
```bash
126
mkdocs serve # with API ref (~10 minutes)
127
API_AUTONAV_EXCLUDE=vllm mkdocs serve # API ref off (~15 seconds)
128
```
129
130
-Once you see `Serving on http://127.0.0.1:8000/` in the logs, the live preview is ready!
131
-Open <http://127.0.0.1:8000/> in your browser to see it.
130
+Once you see a `Serving on http://<address>:<port>/` line in the logs, the live preview is ready!
131
+Open that address in your browser to see it — `http://127.0.0.1:8000/` by default, or whichever host/port you passed to `-a`.
132
133
For additional features and advanced configurations, refer to the:
134
docs/getting_started/installation/gpu.apple.inc.md
+3
@@ -52,6 +52,9 @@ source ~/.venv-vllm-metal/bin/activate
52
vllm serve
53
```
54
55
+Wait for 2-3 minutes until you see application startup complete:
56
+> INFO: Application startup complete.
57
+
58
Once the server is running, you have multiple options to interact with it:
59
60
#### Option 1: Interactive chat