From 12be6b28e7b26350581f1aca38b7c3167d0ad192 Mon Sep 17 00:00:00 2001 From: Gotham-Zolio <18781106300@163.com> Date: Fri, 11 Sep 2026 12:21:29 -0400 Subject: [PATCH] docs: clone over HTTPS, which is what a stranger can actually do Every clone instruction said `git clone git@github.com:PlugRL/...`. SSH needs a key registered with GitHub, which made sense while these repositories were private and only their authors cloned them. They are public now, and the first thing the documentation asks a new reader to do was something they cannot do. Found by running the documented quickstart from scratch on a machine with nothing of this project on it. Co-Authored-By: Claude Opus 5 (1M context) --- docs/user_guide/get_started.md | 4 ++-- docs/user_guide/get_started.zh.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/user_guide/get_started.md b/docs/user_guide/get_started.md index 4198405..6e83d8f 100644 --- a/docs/user_guide/get_started.md +++ b/docs/user_guide/get_started.md @@ -7,8 +7,8 @@ From nothing to a policy that is learning, in two terminals. Neither package is on PyPI. Clone both and install each with `uv`: ```bash -git clone git@github.com:PlugRL/plugrl-server.git -git clone git@github.com:PlugRL/plugrl-env-client.git +git clone https://github.com/PlugRL/plugrl-server.git +git clone https://github.com/PlugRL/plugrl-env-client.git cd plugrl-server && uv sync && cd .. cd plugrl-env-client && uv sync --extra mujoco && cd .. diff --git a/docs/user_guide/get_started.zh.md b/docs/user_guide/get_started.zh.md index bde10b9..38c93ee 100644 --- a/docs/user_guide/get_started.zh.md +++ b/docs/user_guide/get_started.zh.md @@ -7,8 +7,8 @@ 两个包都不在 PyPI 上。分别 clone 并用 `uv` 安装： ```bash -git clone git@github.com:PlugRL/plugrl-server.git -git clone git@github.com:PlugRL/plugrl-env-client.git +git clone https://github.com/PlugRL/plugrl-server.git +git clone https://github.com/PlugRL/plugrl-env-client.git cd plugrl-server && uv sync && cd .. cd plugrl-env-client && uv sync --extra mujoco && cd ..