Repository navigation
docs: fix documentation drift and add docs validation - #191
Merged
Merged
Conversation
- Fix outdated CLI commands in inhand_rot_allegro/README.md: - Update from argparse style (--task, --env_num, etc.) to Hydra style - Use uv run python instead of python directly - Fix path to gen_grasp.py - Add note about argparse vs Hydra usage - Fix non-existent language directory references in docs: - Remove broken links to ../en/, ../ja/, ../ko/ directories - These directories do not exist in the repository - Add docs validation script (scripts/check_docs.py): - Validate script references point to existing files - Check Hydra config keys against known patterns - Validate markdown links point to existing files - Check for outdated argparse flags in Hydra scripts Fixes #162
Remove redundant Chinese README as it's not part of the active documentation structure. Related to #162
TATP-233
added a commit
that referenced
this pull request
May 4, 2026
docs: fix documentation drift and add docs validation
TATP-233
added a commit
that referenced
this pull request
May 30, 2026
docs: fix documentation drift and add docs validation
TATP-233
added a commit
that referenced
this pull request
Sep 4, 2026
docs: fix documentation drift and add docs validation
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.
Summary
This PR fixes issue #162 by addressing documentation drift and adding a docs validation script.
Changes
1. Fixed outdated CLI commands in
inhand_rot_allegro/README.md--task,--env_num, etc.) to Hydra style (task=,algo.num_envs=)pythontouv run pythonto follow project conventionsgen_grasp.py(addedsrc/prefix)2. Fixed non-existent language directory references
../en/,../ja/,../ko/directories in all zh_CN docs3. Added docs validation script (
scripts/check_docs.py)Validates documentation for:
--taskthat should be Hydra style)Validation
make checkpassesmake testpassesDefinition of Done
Fixes #162