Skip to content

docs(readme): separate quick start from guided first runs - #7721

Merged
loopx-agent merged 1 commit into
mainfrom
codex/readme-start-paths-20261030
Oct 30, 2026
Merged

loopx-agent merged 1 commit into
mainfrom
codex/readme-start-paths-20261030

Conversation

@loopx-agent

Copy link
Copy Markdown
Collaborator

Goal And Delivered Outcome

README 的 “Start in two steps” 与 “Try LoopX” 重复安装命令和任务示例,教程、宿主差异和升级说明挤在同一路径中。本次让顶部回答“怎样开始”,Try 区回答“先试什么任务”,宿主表回答“如何确认续跑”,中英文同步。

  • 顶部明确安装、发起任务两步;安装维护链接直接进入安装指南。
  • Try 区集中三个已有教程:修复小型项目、持续改进自己的仓库、使用个人工作区。
  • 区分 Codex App heartbeat、CLI 原生 Goal 和其他宿主入口,链接到对应激活说明;保留 setup packet 与实际启动的区别。
  • “Install and start” 回到顶部安装入口;保留既有标题、锚点、进阶宿主表与首次运行反馈。
  • Intended base: loopx-project/loopx:main;仅修改两份 README。

Author Declaration

  • Written by: model_agent — OpenAI GPT-6 (Codex).
  • Specification and revision: no separate written specification; the maintainer request summarized above is the basis. README baseline: 8d80235239d3b3a7cddf76df4c92924f75bea524.
Criterion Disposition Path Evidence
两节分工清楚,去除重复启动内容 implemented README.md, README.zh-CN.md 每种语言只保留一处安装命令与任务示例;实际渲染见下
链接对应读者下一步,保留旧入口 implemented 两份 README 的 quick-start、Try 和 host setup 24 处新增或改写的本地链接与锚点检查;浏览器跳转与教程读取
中英文对齐并保持原有操作边界 implemented 两份 README 对照既有入门、安装与宿主指南;未改变运行代码、命令或默认行为

Scope And Continuation

Complete within this scope. Bounded refactoring applied to the existing onboarding content: consolidate repeated setup and reuse existing guides. No new document, runtime surface, test or successor is needed.

Validation

  • Tested revision: 2066de1b756efb134ca27f2eb33cc8d3eb72525e.
  • Run state: finished. Input classes: public_fixture.
Check kind Result Evidence / limitation
static passed python examples/public_entry/readme-demo-surface-smoke.py
static passed python examples/docs-governance-smoke.py
static passed python examples/docs-asset-integrity-smoke.py
static passed git diff --check; 24 changed local link/anchor references resolve; existing public-boundary scanner reports both README files clean
manual passed Actual GitHub README rendering at desktop 1200 × 888 and narrow 390 × 844; English and Chinese section anchors verified, Try jump and bug-fixing guide opened
static failed Full loopx check did not complete registry validation. Its file scan was clean; the same public-boundary scanner was separately invoked successfully for the two changed files. No registry/runtime qualification is claimed.

Documentation and navigation only; model execution, host activation and installed product behavior were not requalified. Remote CI is pending at submission.

Frontend / Visual Evidence

UI impact: changed documentation presentation. Source data: public_fixture. These are actual GitHub-rendered README captures, not an installed App or a simulated host run. Before uses the baseline README blob, unchanged between 2fbd47f and 8d80235; after uses 2066de1.

English preview · 中文预览

First viewport after — desktop:

Two-step start after, desktop

Before, Try section, and narrow-screen comparisons

First viewport before — desktop:

Two-step start before, desktop

Try section before → after — desktop:

Try before, desktop
Try after, desktop

Two-step start before → after — narrow:

Two-step start before, narrow
Two-step start after, narrow

Try section after — narrow:

Try after, narrow

Attention review: the first screen focuses on the two actions; walkthrough choices move to Try instead of competing with startup. Existing installation recovery, host differences and activation caveats remain reachable. Narrow tables wrap within the page; command blocks retain GitHub's horizontal scrolling. GitHub controls the documentation chrome; no custom styling or runtime states changed.

Type / Area

  • Documentation update — public README presentation and navigation.
  • Shared-authority RFC fixture impact: N/A; no RFC or authority contract changed.

Boundary Checklist

  • Public-safe text and rendered repository content only; captures are attached, not committed.
  • Explicit staging limited to README.md and README.zh-CN.md.
  • No paired RFC changes.
  • DCO sign-off included.
  • No merge requested.

Signed-off-by: LoopX Agent <337587101+loopx-agent@users.noreply.github.com>
@loopx-agent
loopx-agent merged commit 5b224f0 into main Oct 30, 2026
5 of 6 checks passed
@loopx-agent
loopx-agent deleted the codex/readme-start-paths-20261030 branch October 30, 2026 04:39
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.

1 participant