Repository navigation
docs: polish onboarding guides and surface them in README - #7694
Merged
Merged
Conversation
Signed-off-by: LoopX Agent <337587101+loopx-agent@users.noreply.github.com>
Signed-off-by: LoopX Agent <337587101+loopx-agent@users.noreply.github.com>
Signed-off-by: LoopX Agent <337587101+loopx-agent@users.noreply.github.com>
Signed-off-by: LoopX Agent <337587101+loopx-agent@users.noreply.github.com>
Signed-off-by: LoopX Agent <337587101+loopx-agent@users.noreply.github.com>
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
Readers need a complete first-use path after following the README links. The bug-fixing tutorial previously introduced recurring work before the exercise's verification step; the coding guide led with a different installer from the current installation guide; and the Workspace manual opened with a feature list and video rather than a first task.
This change improves the linked content as well as its discovery:
Outcome basis: maintainer request to surface useful onboarding guides and improve their content. Intended base:
main; no issue closure claimed.Author Declaration
Implemented against
docs/development/documentation-layout.mdanddocs/development/design.mdat10c84d1c0c97820499db595be55023283a28fa08.README.md,README.zh-CN.mddocs/guides/long-running-coding-agents.md,docs/guides/first-bugfix-loop{,.zh-CN}.mddocs/guides/first-bugfix-loop{,.zh-CN}.mddocs/guides/long-running-coding-agents.mddocs/guides/personal-workspace-user-guide.mdScope And Continuation
Validation
5e09a3394d110c5a4cd3179b050124219974e9db.git diff --check; scoped check resolves all six guide links and confirms the rest of both READMEs is unchanged; all 44 relative links/images in the four guide files resolve, fences are balanced, and legacy/new exercise anchors and the new cross-language refactoring targets existloopx checkwith the six explicit changed-file scan paths: public-boundary scan completed with no findings; subsequently changed guide files were scanned againloopx checkhealth result is not green: the isolated check environment has no registry. This is distinct from the completed public-boundary scanPYTHONPATH=. uv run --no-project --python 3.12 --with-requirements docs/requirements-docs.txt mkdocs build --strictwith output outside the checkout; complete documentation site built successfully. Existing INFO-level link notices elsewhere are not claimed resolved9f32985599910e520b76da1c21df0c453db4ae63: Release Artifacts browser smoke timed out waiting for the Goal overview refresh button ingoal-work-map.mjs. Base attribution has not been established; this documentation-only PR does not repair that pathFrontend / Visual Evidence
10c84d1c0c97820499db595be55023283a28fa08; guides before:e662272326bc20a4f7f72d6239a1f10a9d622d1d.5e09a3394d110c5a4cd3179b050124219974e9db. The coding/Workspace opening and Workspace-task captures retain67a2df9e6e7fd0af8e383c4f9108bca9dddcc9f7; their displayed content is unchanged. The Chinese exercise opening is refreshed at the current head. README captures below are frome662272326bc20a4f7f72d6239a1f10a9d622d1d; both README blobs remain unchanged at the current head.Guide previews: bug-fixing exercise (EN), 查 bug 练习, coding agents, Workspace.
Continuous-refactoring examples
New content; before: N/A for these sections. This is a documented task example, not evidence of a completed repository refactor or measured maintainability gains.
Preview: English example, 中文示例. The explicit Chinese anchor works in GitHub and MkDocs.
Narrow views (390×844):
Guide opening viewports in GitHub (1440×1000):
Narrow guide views (390×844):
Workspace first-task instructions (public documentation, not a live execution screenshot):
English onboarding viewport, before and after (1440×1000):
Chinese onboarding viewport, before and after (1440×1000):
Narrow onboarding views (390×844):
Type of Change
LoopX Area
Technical Direction
Shared-authority RFC fixture impact
N/A — no shared-authority, runtime-routing, or protocol change.
Boundary Checklist
Signed-off-bytrailer.