docs: the quickstart on the home page could not be run - #11
Merged
Merged
Conversation
It opened two terminals and ran the CLIs with no install step above them. Neither package is on PyPI, which get_started.md says and the home page only linked to from its last section, so a reader following the front page in order met command not found. The four lines are copied from that page so the two recipes cannot drift. Two smaller things, both languages: a line after the intro now says a full-size pi0.5 ran end to end and that the RL result is negative, linking to that section, because the page led with a sentence any framework could write; and the opening note is an admonition like every other callout on the page rather than a bare blockquote.
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.
The quickstart on the home page could not be run as written.
The gap
It opens two terminals and runs
plugrl-run-serverandplugrl-run-env-client, with no installation step anywhere above them. Neither package is on PyPI -user_guide/get_started.mdsays so and gives the clone-and-uv syncrecipe - but the home page only links to that page from the very bottom, under "Next steps". A reader following the front page in order meetscommand not found.The four lines from Get Started now sit above the terminals, with a pointer to the full page for the other environment extras. Copied from that page rather than rewritten, so the two cannot drift apart into two different recipes.
Two smaller things, in both languages
!!! note, like the others.Anchors
#a-real-vla-end-to-endin English. In Chinese the slugifier drops CJK, so headings there get_1,_3, and so on; that heading keeps its Latin letters and becomes#vla. Both were read out of the built HTML rather than guessed:mkdocs build --strictpasses.