Skip to content

docs(readme): explain the benefits of cloud deployment - #200

Open
newexploreor wants to merge 3 commits into
mainfrom
feature/readme-cloud-benefits
Open

newexploreor wants to merge 3 commits into
mainfrom
feature/readme-cloud-benefits

Conversation

@newexploreor

@newexploreor newexploreor commented Nov 12, 2026 •

Copy link
Copy Markdown
Collaborator

What changed

Add a cloud deployment section at the start of Quick start in both READMEs.

  • Lead with online team collaboration. Teammates can sign in to the same workspace from different locations, file a requirement, run a shared SOP, and review or approve work in the browser. Progress, approvals and the PR stay linked to the requirement.
  • Explain that cloud SOP runs and scheduled jobs can continue after a developer shuts down their computer.
  • Explain how parallel builds and tests in cloud Docker sandboxes free up developers' machines. Connected runners can still handle tasks that need local tools or private network access.

Scope

  • Documentation only

Validation

  • git diff --check origin/main
  • python3 scripts/check-public.py
  • Verified online collaboration is listed first in both READMEs and the deployment links resolve.

@Robert0622

Copy link
Copy Markdown
Collaborator

LoopForge PR Review — head a0dfcbb2483cc709729a3ff609cf648f22cfb2f6

Conclusion: Pass ✅

Documentation-only change (+8/+8 lines in README.md / README.zh-CN.md, new "benefits of cloud deployment" section, Chinese/English kept in sync). No code paths affected.

  • GitHub CI: all checks green
  • Reviewed both language versions for consistency — content matches, no broken links or formatting issues
  • No tests applicable; no risk to runtime behavior

No blocking issues.

@Yanami-2K Yanami-2K left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

内容本身没有问题,但和同一作者的 #163 互相冲突,需要只保留一个:

  1. 与 #163 修改同一段 本 PR 在 README.md 和 README.zh-CN.md 的 ## Quick start / ## 快速开始 下、“Install Git and clone the repository first”那一行之前插入了“Why deploy to the cloud?”。#163 正好改了这一行(加了“Runs on macOS and Linux…”),还在后面新增了“Install on a cloud server”小节。两个 PR 会产生文本冲突,而且“为什么上云”和“怎么上云”分在两个 PR 里也不利于维护。建议保留 #163,把本 PR 的三条要点合并到 #163 的“Install on a cloud server”小节开头,然后关闭本 PR。
  2. 如果维护者更希望先合入本 PR:请先 rebase 到最新 main。本 PR 的 hunk 从第 67 行开始,而 #163 和 #172 基于的 main 里同一段已经从第 71 行开始,说明这个分支的基线较旧。另外,“See the deployment guide for HTTPS and runner setup”与 #163 新增的 HTTPS 折叠段重复,需要和 #163 协调,只保留一处入口。

@Robert0622

Copy link
Copy Markdown
Collaborator

LoopForge PR Review — head a0dfcbb2483cc709729a3ff609cf648f22cfb2f6

Verdict: ❌ Not pass — @newexploreor

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.

3 participants