Skip to content

docs: lead README with value and a compact quick start - #6975

Merged
huangruiteng merged 2 commits into
mainfrom
codex/readme-value-first-20261021
Oct 21, 2026
Merged

huangruiteng merged 2 commits into
mainfrom
codex/readme-value-first-20261021

Conversation

@loopx-agent

@loopx-agent loopx-agent commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

Goal And Delivered Outcome

New readers had to pass release notes, architecture and product terminology before understanding LoopX or starting a first task. The English and Chinese READMEs now lead with a clear value proposition and a compact two-step start, followed by Why LoopX, the product walkthrough, full setup guidance, inspectable evidence and participation.

  • The early start contains the supported runtime prerequisites, the install command and a concrete Codex task; Claude Code and other-host guidance stay one link away.
  • The later Try section retains the complete host table, diagnostics, install alternatives and upgrade guidance. The short install/task pair intentionally appears in both places, with identical commands.
  • Why LoopX stays ahead of the product walkthrough. The film sits beside the product; architecture and optional workflow detail remain in disclosures; contribution links precede advanced references.
  • Evidence qualifiers, status, license, community, partner and advanced references are retained. The proposal makes no measured adoption, conversion or model-improvement claim.
  • Target: loopx-project/loopx:main. The branch incorporates db4b000cf1926dff66a67c3d4f343a080a37bb07. The original before screenshots use 5fb961c363c125589f3c0dd3d2cefd017c7b4f4e; both README files are unchanged between those two base revisions.

The separate GitHub repository description was also updated and read back during the original author delivery:

Turn long-horizon goals into verifiable results. A local-first control plane and research workbench for agents and teams, across sessions and runtimes.

Author Declaration

  • Written by: model_agent, OpenAI Codex, under owner direction.
  • Specification: the requested README information-architecture and repository-introduction improvement; existing repository design, contribution and public-evidence rules at the baseline above.
  • Self-check: inspected both changed documents, compared retained evidence/reference sections, checked local links and legacy anchors, and inspected actual GitHub-rendered desktop and narrow views. No runtime, capability, permissions or installation behavior changes.

Scope And Continuation

Complete author proposal for the two root READMEs. The repository About edit is separate metadata and has already been applied. No new module, dependency, generated repository asset or runtime work is introduced. Review and merge remain separate; no PR merge or release was performed.

Validation

  • Tested revision: 61c55e356cd70d7157b4a626906d08c11aac2c06.
  • Run state: finished.
  • Input classes: public_fixture.
Check kind Result Public-safe evidence / limitation
static passed git diff --check; 317 local Markdown/HTML references and anchors resolved across both READMEs; retained evidence/reference sections compared with baseline; balanced disclosures.
regression_parity passed examples/public_entry/readme-demo-surface-smoke.py, examples/core-control-plane-diagrams-smoke.py, and examples/readme-star-history-smoke.py. Existing diagrams, runtime entry paths, community links and star-history placement retained.
static passed loopx check --scan-path README.md --scan-path README.zh-CN.md: two-file public-boundary scan clean, zero errors/warnings. Bilingual RFC diff check passed; no RFC changed.
manual passed Actual GitHub-rendered English and Chinese READMEs at the exact baseline/head, desktop 1200×878 and narrow 390×844. First section order and image availability read back; screenshots below.
static failed The new head still reaches the existing goal-outcome-refinement-v0.md “semantic mirror” assertion in examples/docs-governance-smoke.py. The original author delivery reproduced the same failure with immutable-baseline README reads. The failing checker and RFC are unchanged between the original base and the incorporated main. No assertion or RFC was changed by this proposal, and no waiver is claimed.
integration not_applicable Documentation and repository metadata only; no product runtime/backend change.

GitHub CI, independent review and merge readiness are separate from the checks above. No passing full-suite or installed-product claim is made.

Frontend / Visual Evidence

  • UI impact: changed — README content hierarchy in GitHub's existing Markdown renderer; no CSS or application UI changes.
  • Preview: English, 中文.
  • Source data: public_fixture. These are public repository document renders, not App/runtime or model acceptance evidence.
  • Attention review: one value proposition, a compact two-step start before Why and the product walkthrough, direct paths to contributing, and detailed mechanics available on demand. The product film and Trendshift badge have relevant later homes. Evidence qualifiers, migration guidance and authority boundaries remain reachable.
  • Craft review: inspected both languages at desktop and 390px widths. GitHub owns typography, wrapping and controls; no new visual system or interactive state. No loading/error/permission behavior changed.
View Before: 5fb961c36 After: 61c55e356
English desktop English desktop before English desktop after
English narrow English narrow before English narrow after
中文桌面 中文桌面调整前 中文桌面调整后
中文窄屏 中文窄屏调整前 中文窄屏调整后

Type of Change

  • Documentation update

LoopX Area

  • Public docs or presentation surface

Technical Direction

Public product understanding, first-workflow discovery and contributor participation over the existing shipped foundations. No new roadmap or delivery-maturity claim.

Shared-authority RFC fixture impact

N/A: no shared authority, state, protocol, store or migration change.

Boundary Checklist

  • Public docs and public repository screenshots only; no private state, credentials, raw traces, internal links or local machine paths in the proposal.
  • No benchmark execution, scoring change or duplicated research work.
  • Scope limited to the requested README organization and repository description.
  • No paired RFC changed; bilingual diff check passed.
  • Desktop/narrow before-and-after evidence is embedded above for both languages.
  • Commit carries DCO sign-off.

Signed-off-by: LoopX Agent <337587101+loopx-agent@users.noreply.github.com>
Signed-off-by: LoopX Agent <337587101+loopx-agent@users.noreply.github.com>
@loopx-agent loopx-agent changed the title docs: lead README with value and guide readers to adoption docs: lead README with value and a compact quick start Oct 21, 2026
@huangruiteng
huangruiteng merged commit 4e6baa5 into main Oct 21, 2026
28 of 29 checks passed
@huangruiteng
huangruiteng deleted the codex/readme-value-first-20261021 branch October 21, 2026 04:20

@loopx-agent loopx-agent left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Reviewer: model_agent; model=gpt-6.1-sol; provider=OpenAI; declaration_source=runtime_reported; reasoning_effort=max

Approval conclusion (author-owned PR; GitHub blocks formal self-approval)

未发现本次变更新引入的阻塞问题。审计版本:61c55e356cd70d7157b4a626906d08c11aac2c06,实际 PR base:db4b000cf1926dff66a67c3d4f343a080a37bb07。发布前 head 更新并由维护者合并,因此以下是对已合并版本的完整审计,不能当作合并前批准或权限记录。

动机

首次打开仓库、希望了解用途并开始一个项目任务的 Agent 使用者,以及寻找参与入口的贡献者。 以前读者先经过较长的发布与展示内容,才找到用途解释和完整安装路径;现在先看到价值说明和两步开始,再按需要进入产品演示、完整设置、证据与贡献入口。 两份 README 的实际 GitHub 渲染、开始使用跳转、中文窄屏阅读及旧锚点兼容已核验,详细机制仍可展开阅读。 本次只评审 README 信息组织;不宣称实际安装、模型采用、转化率或长程效果已经提升,也不以审核结论追认合并权限。

改动思路

保留两份现有入口和 GitHub 的 Markdown 渲染器,把价值说明、简短开始、用途解释、实际产品、完整设置、证据与参与路径按阅读任务组织。只改一句口号不能解决长展示内容遮住下一步的问题;另造网站或安装向导又会增加维护边界。简短开始有意复用完整设置里的安装和任务命令,完整宿主表、诊断及升级说明仍在原来的详细设置区。两份命令一致,读者不必为理解架构先展开可选细节,也没有新增确认轮次。HTML 折叠只管文档展示,不承担权限或运行决策。

阅读任务 原入口 当前入口
理解用途并开始 较长发布与展示内容后寻找说明 价值说明 → 两步开始 → 用途与产品
需要其他宿主或诊断 完整设置区 两步开始中的链接 → 同一完整设置区
核查证据或参与 向下查找 顶部直达,原有限定与贡献边界保留

该表是源码结构说明;实际渲染与点击验证单独执行。

具体改动

关键内容讲解

README.md 与 README.zh-CN.md 是全部变更文件,+614/-545 主要来自原有区块移动、标题层次和折叠包装。前部增加简短价值与“两步开始”,随后解释 Why,再给产品演示;研究影片回到产品说明旁,贡献入口早于进阶参考。完整设置保留 Python 3.11+、Node.js 22.22.3+(推荐 24 LTS)、原安装命令、重启宿主、打开项目和各宿主调用方式。前后重复的简短命令对已经逐项比较,不能将“看见命令”当作实际安装成功。

证据、进阶路径、技术方向、进阶文档、状态、许可证、伙伴与社区八类区块,在每种语言中均保持原正文;没有把限定性观察改写成效果承诺。保留旧标题/显式锚点,包括移动后的发布锚点。当前每份文档 113 个不同本地目标均解析通过,基线各109个;独立删除旧发布锚点会使兼容检查失败,恢复原字节后通过。

规范依据为 docs/development/design.md,固定版本 5fb961c363c125589f3c0dd3d2cefd017c7b4f4e。Earn The User's Attention 对应开场价值、两步开始和直接导航,实际检查英文 1200×878 与中文 390×844 渲染;Explanations On Demand 对应保留详细说明的折叠和完整设置链接,源码及实际跳转均验证。最初审阅版本更新后,重新核对了完整两文件差异、主干并入造成的证据失效范围,并对最终版本重跑验证,没有把旧版本的首屏坐标沿用成新版本证据。

对主干的风险

主要风险是移动内容时丢失旧链接、迁移限制或证据条件。源码/锚点盘点、隔离副本的删除反例、两份完整设置与八类保留正文比较覆盖了这类风险。最终 head 的 demo、diagram、star 三项原生文档 smoke 均通过;标准 premerge 的4项直接检查和13项选中检查也通过,包含双语差异与公私边界。中文证据和贡献链接在等待完整渲染后实际导航,目标标题进入视口(图片布局曾拦截鼠标,随后用键盘完成);第一次过早检查到的未完成 DOM 没有被当成产品缺陷或通过证据。

完整 examples/docs-governance-smoke.py 仍失败:base 和 head 都在第209行对 goal-outcome-refinement-v0.md 的 semantic mirror 断言退出1。仅替换 checkout 根路径后的完整错误字节相同,检查器和被检查 RFC 未改动,因此归为既有无关失败;该红项没有被豁免或改写为通过。未查询或等待 CI。文档移动不改变运行时、权限、自动加载提示或可选能力启用,但这也没有验证安装态、所有外链可用性或新用户理解效果。

我的整体评价

交付判断为 goal_achieved:两份公开入口的组织与第一步可发现性构成完整、可回滚的文档切片。long_horizon 为 preserved:原有持续工作、证据和迁移/启用条件保留,不能据此宣称长程收益;user_experience 为 improved:实际阅读与导航路径改善,转化和理解度仍未测量。兼容只需要保留已有公开锚点,无需新协议或服务;标题属于本地文档语义,没有新增共享状态词汇。结论 APPROVE 针对此精确版本的文档变化;维护者已合并的事实、既有质量失败、安装与模型资格分别记录,本审计不追认权限。

English verdict: APPROVE — 61c55e356cd70d7157b4a626906d08c11aac2c06. Post-merge audit found no new blocking issue in the complete two-README diff. Exact-head render/navigation, legacy-anchor negative/restore checks, native README smokes and standard scoped canaries passed. The full docs-governance assertion is identically failing on the immutable base; installation, conversion and model efficacy remain unqualified. This COMMENTED author-account conclusion is not formal self-approval or retroactive merge authorization.

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.

2 participants