Repository navigation
docs: strengthen community entry and contributor avatars in both READMEs - #7394
Conversation
Signed-off-by: LoopX Agent <337587101+loopx-agent@users.noreply.github.com>
loopx-agent
left a comment
There was a problem hiding this comment.
Reviewer: model_agent · gpt-6.1-sol · OpenAI · runtime_reported · reasoning_effort=max
Post-merge audit — reviewed head 4c7e7a83abba8de3140619c5adb91243da0f97b2
[P2] 保留原英文社区标题生成的锚点 — README.md:584。旧标题 Community and Feedback 的实际 GitHub 永久链接是 #community-and-feedback;此处只保留了另一个旧别名 community--feedback。我用同一浏览器打开基线旧链接和此提交的旧链接:前者定位到社区标题,后者目标不存在、停在页首。最小修复是在现有别名旁加 <a id="community-and-feedback"></a>,并检查两种旧片段都能定位。PR 已合并,这是一项需要后续修复的审计意见。
动机
准备了解社区、报告问题或开始第一次贡献的英文和中文 README 读者。旧版把参与入口拆在两个段落;新版合并入口并展示贡献者,但使用旧英文社区书签的读者会落在页首,无法直接找到原社区位置。新的参与路线、贡献者头像和完整名单可以读到;旧英文社区锚点的兼容性尚未保留。本 PR 只调整两份 README,不改变运行时、安装、调度、权限、发布或维护者身份。英文旧社区书签需恢复;这是同一文档边界内的一行别名修复,不需要增加产品功能。
合并入口本身有明确价值:新读者能按了解、讨论、报告、贡献或群聊选择路线,贡献者归属也更容易发现。但此请求明确保留旧导航,不能只验证新增链接。这里不以代码行数、截图或 premerge 数量代替读者能完成原任务的结果。
验收依据是 docs/development/design.md,固定版本 c6462f902a1c6a519eb4752b62637580f0e9cd35,特别是 Source Of Truth 的行为保留及默认/按需内容规则。条目 preserve-existing-behavior 未满足:旧英文生成锚点失效;条目 default-and-requested-detail 已验证:默认路线、贡献者及展开的完整分享边界在实际 GitHub 页面可读。OpenViking 的固定版本参考提供布局灵感;LoopX 的贡献、支持及维护权限仍由本仓库现有文档定义。
改动思路
这个改法复用 README 的原生 Markdown、既有链接和 disclosure,足以改善社区入口,无须增加贡献者数据库、前端组件或定时生成任务。对照不改动和更小修复后,保留合并入口、补一个精确旧别名就是完整且可回退的边界。外部头像图只是展示,不能赋予维护权限;作者与角色说明仍可从归属及治理链接查到。
| 读者任务 | 当前结果 |
|---|---|
| 从顶部 Contribute/参与贡献进入 | 原英文 contributing 和中文 贡献 别名仍存在。 |
| 使用旧社区链接 | 中文 用户群与反馈 及英文显式 community--feedback 保留;英文生成的 community-and-feedback 丢失。 |
| 查看贡献者与分享限制 | 头像、完整 GitHub 名单和按需展开的完整限制均可读。 |
具体改动
完整 diff 只有 README.md(+44/-27)和 README.zh-CN.md(+40/-23)。两份内容均把贡献与反馈段落合并,补齐文档、博客、讨论、Issue、公开任务及原聊天路线;Support、行为准则、治理、创建者与贡献记录、历史和标识文档继续沿原 owner。较大改动先讨论的提示与 CONTRIBUTING 的既有流程一致,不新增机器准入要求。
Contributors/贡献者 使用同一仓库的 contrib.rocks 图,图后保留完整 GitHub 名单文字链接,原飞书和微信图片及联系说明继续放在群聊段落。两份头像的仓库、列数及最大数量相同,没有维护一个手工名单。图片实际加载,但完整名单、治理及归属文本的可达性与图片分开检查,不把外部图片视为完整或永久权威。
分享限制移入原生 details 后,状态目录、原始会话和 benchmark 材料、凭证、私有日志、内部链接、敏感用户/团队信息及操作员产物等排除仍可完整读取。对照了原文和 CONTRIBUTING、Support;折叠改变默认呈现,没有降低公开贡献的清理义务。代码实现、模型执行和安装配置均未变化。
对主干的风险
最强反例已经复现:只检查显式旧别名或新的社区标题会漏掉 GitHub 由旧标题生成的真实入口。标准 premerge 通过也不会保护这个 URL。修复应补准确的旧片段,并在实际渲染页验证,避免通过保留相似字符串误判兼容。影响局限在旧英文社区深链接,顶部贡献入口和中文别名可用。
本地标准 loopx canary premerge --from-git-diff --git-diff-base c6462f902a1c6a519eb4752b62637580f0e9cd35:4 项直接检查及 13 项选中自动检查通过。完整 diff 与 DCO trailer 已核对;局部目标文件均存在,两份 README 的公开边界扫描清洁。独立 loopx check 在基线和 head 返回逐字相同的两项既有本地 registry authority 错误,因此整体失败仍保留,未归因于本 PR。现有 examples/public_entry/readme-demo-surface-smoke.py 在两端均以相同完整归一化 traceback 停在未改动的第 69 行 AssertionError: long-horizon agents;脚本和相关 hero 文案不在此次修改路径,不能把这个失败写成通过。
没有查询或等待 CI,也没有为 Markdown 改动扩展运行时测试。GitHub Markdown API 的返回 HTML 本身不生成实际页面的标题锚点,基线也一样;它不能作为旧锚点通过的证据,本次判断来自真实 GitHub 页面目标与滚动位置。图片服务持续可用性和真实参与转化没有验证。
我的整体评价
实际 GitHub 页面中,默认社区段落先呈现参与路线,再呈现贡献者和群聊;分享边界收在原生 disclosure 内。桌面及 390px 视图的正文、展开指引和下方完整名单可读,头像墙缩入正文列,二维码窄屏纵向排列。旧链接失效属于导航回归,不能用这些可读画面抵消。
未验证真实读者的理解或参与转化、外部头像服务的持续可用性,也未测试独立部署的文档站;本次是 GitHub 的实际 Markdown 阅读页。
两种语言的默认内容、展开原文和下方群聊均实际走查;代表性的中文完整展开及英文头像/名单区另作 390px 画面检查。英文 disclosure 用 Enter 打开、关闭,焦点保留在 summary。没有横向溢出和文本存在是辅助断言,不能代替这些画面阅读判断。
文档入口的整合是合理增量,现有 owner 与公开分享规则被复用;同一审计仍需给出 REQUEST_CHANGES,因为实际旧导航回归尚未修复。最小后续工作是补一个旧锚点并回读,不需要撤销全部内容或增加新的授权流程。本评审不执行合并、回滚或安装。
English verdict: REQUEST_CHANGES — post-merge audit of 4c7e7a83abba8de3140619c5adb91243da0f97b2. The bilingual community grouping, contributor fallback and full sharing disclosure are usable, but the former GitHub-generated #community-and-feedback permalink disappears. Restore that exact alias and verify the rendered target. Standard local premerge passed; the unchanged surface-smoke and local registry failures were reproduced on the immutable base. No CI, merge or installed-App qualification is claimed.
| Help make long-horizon Agent work easier to run, inspect and trust. | ||
| Contributions can start with a host integration, a reproducible bug, a | ||
| documented workflow or a carefully bounded evidence study. | ||
| ## Community & Contributing |
There was a problem hiding this comment.
[P2] Preserve the previous generated community permalink
Renaming the old Community and Feedback heading removes GitHub’s #community-and-feedback target. The retained community--feedback anchor is a different legacy URL. On the immutable base the old permalink scrolls to the community section; on this head the target is absent and the page stays at the top. Add <a id="community-and-feedback"></a> beside the existing aliases and verify both old fragments on the rendered README. This is a post-merge follow-up repair.
Outcome
Bring the English and Chinese README community entries together, using OpenViking's Community & Contributing section as the reference.
contrib.rocks, plus a text link to the complete GitHub contributor view.Author and scope
Written by: model_agent — OpenAI Codex.
Specification: the maintainer-requested README refresh described above; no separate written specification. Presentation follows
docs/development/design.mdat basec6462f902a1c6a519eb4752b62637580f0e9cd35.README.md,README.zh-CN.md; rendered desktop/narrow reviewComplete within this documentation scope. No runtime, scheduler, permissions, installation, release or merge behavior changes. No new scheduled asset generation or manually maintained contributor list. The avatar image depends on the external image service; the text link to GitHub's complete list remains available.
Validation
Tested revision:
4c7e7a83abba8de3140619c5adb91243da0f97b2. Run state: finished. Inputs: public_fixture.loopx canary premerge --from-git-diff --git-diff-base origin/mainloopx checkalso reports two unrelated local-registry authority errors, so its overall exit is failedexamples/public_entry/readme-demo-surface-smoke.pylong-horizon agentsassertion; reproduced using the unmodified base READMEs. This existing failure is not counted as a passVisual evidence
Public README content rendered through GitHub's Markdown API in an isolated preview, with a lightweight GitHub-style reading frame. These captures cover the changed section, not a packaged App or deployed Pages build.
English README preview · 中文 README 预览
The main README hero is unchanged. The community section now presents participation routes together and shows contributors before the existing chat QR codes. The narrow layout keeps the avatar wall within the reading column; the complete contributor list remains one click away.
Desktop section: before → after
Narrow section: 390px
Boundary