docs: correct 17 site claims, in both languages - #6
Merged
Merged
Conversation
The documentation site described flags and APIs that do not exist. A reader following it would have failed at the first command on several pages. Flags: `--num-workers` is `--num-procs`; `--use-env-lock` is `--runner.use-env-lock`; `--use-real-time` and `--fps` do not exist at all; `--track.enabled true` and `--resume true` are parse errors rather than no-ops. A literal backslash-n inside a bash fence broke the first runnable command in the user guide. Templates: the custom policy page imported a type that does not exist and asked the reader to implement two methods that are not in the interface; the custom algorithm template overrode `learn` and never defined `learn_impl`, so the class it produced was still abstract; the custom env template's constructor signature did not match how the runtime instantiates envs. Lists: the built-in environment list omitted `mujoco-v1`, the algorithm list omitted `fpo` and `eval`, and the policy list omitted `fpo-policy` - the three things the quickstart on the front page actually uses. Every correction is applied to the Chinese page as well as the English one. `mkdocs build --strict` passes. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.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
1 participant
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 site documented flags and APIs that do not exist. A reader following it would have failed at the first command on several pages.
Flags.
--num-workersis--num-procs.--use-env-lockis--runner.use-env-lock.--use-real-timeand--fpsdo not exist at all.--track.enabled trueand--resume trueare parse errors rather than no-ops. A literal\ninside a bash fence broke the first runnable command in the user guide.Templates. The custom policy page imported a type that does not exist and asked the reader to implement two methods absent from the interface. The custom algorithm template overrode
learnand never definedlearn_impl, so the class it produced was still abstract. The custom env template's constructor signature did not match how the runtime instantiates envs.Lists. The built-in environment list omitted
mujoco-v1, the algorithm list omittedfpoandeval, and the policy list omittedfpo-policy— the three things the front page quickstart actually uses.Every correction is applied to the Chinese page as well as the English one.
mkdocs build --strictpasses.Found by an adversarial audit of all four public repositories: 82 findings raised, 67 survived an independent attempt to refute them.
🤖 Generated with Claude Code