Repository navigation
docs(readme): separate quick start from guided first runs - #7721
Merged
Merged
Conversation
Signed-off-by: LoopX Agent <337587101+loopx-agent@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Goal And Delivered Outcome
README 的 “Start in two steps” 与 “Try LoopX” 重复安装命令和任务示例,教程、宿主差异和升级说明挤在同一路径中。本次让顶部回答“怎样开始”,Try 区回答“先试什么任务”,宿主表回答“如何确认续跑”,中英文同步。
loopx-project/loopx:main;仅修改两份 README。Author Declaration
8d80235239d3b3a7cddf76df4c92924f75bea524.README.md,README.zh-CN.mdScope 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
2066de1b756efb134ca27f2eb33cc8d3eb72525e.python examples/public_entry/readme-demo-surface-smoke.pypython examples/docs-governance-smoke.pypython examples/docs-asset-integrity-smoke.pygit diff --check; 24 changed local link/anchor references resolve; existing public-boundary scanner reports both README files cleanloopx checkdid 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
2fbd47fand8d80235; after uses2066de1.English preview · 中文预览
First viewport after — desktop:
Before, Try section, and narrow-screen comparisons
First viewport before — desktop:
Try section before → after — desktop:
Two-step start before → after — narrow:
Try section 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
Boundary Checklist
README.mdandREADME.zh-CN.md.