Skip to content

docs: fix documentation drift and add docs validation - #191

Merged
TATP-233 merged 2 commits into
mainfrom
fix/issue-162-docs-drift
Apr 9, 2026
Merged

TATP-233 merged 2 commits into
mainfrom
fix/issue-162-docs-drift

Conversation

@TATP-233

@TATP-233 TATP-233 commented Apr 9, 2026

Copy link
Copy Markdown
Collaborator

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

  • Updated from argparse style (--task, --env_num, etc.) to Hydra style (task=, algo.num_envs=)
  • Changed python to uv run python to follow project conventions
  • Fixed path to gen_grasp.py (added src/ prefix)
  • Added note about argparse vs Hydra usage distinction

2. Fixed non-existent language directory references

  • Removed broken links to ../en/, ../ja/, ../ko/ directories in all zh_CN docs
  • These directories do not exist in the repository

3. Added docs validation script (scripts/check_docs.py)

Validates documentation for:

  • Script references (scripts/*.py must exist)
  • Hydra config keys (common keys must match expected patterns)
  • Relative links (markdown links must point to existing files)
  • Outdated argparse flags (flags like --task that should be Hydra style)

Validation

  • make check passes
  • make test passes
  • Docs validation script runs successfully

Definition of Done

  • README, CONTRIBUTING, env README and training docs command styles are consistent
  • No incorrect script paths or deprecated parameters in active docs
  • Docs-only changes can trigger minimal docs validation
  • Documentation structure rules match current repository layout

Fixes #162

- 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
TATP-233 merged commit 663fa6f into main Apr 9, 2026
@TATP-233
TATP-233 deleted the fix/issue-162-docs-drift branch April 9, 2026 18:22
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Work: 修复文档入口漂移并为 docs-only 变更加校验

1 participant