Skip to content

docs: fix README path references in docs/ directory#13

Merged
chinaestone merged 2 commits intomasterfrom
docs/fix-readme-paths
Jan 10, 2026
Merged

docs: fix README path references in docs/ directory#13
chinaestone merged 2 commits intomasterfrom
docs/fix-readme-paths

Conversation

@chinaestone
Copy link
Copy Markdown
Contributor

Summary

Fix incorrect path references to README files in the docs/ directory and add AGENTS.md sync mechanism.

Changes

Path Fixes (6 locations)

  • docs/GITHUB_ACTIONS.md: Fixed 3 GitHub Actions document paths (added ../ prefix)
  • docs/README-ZH_CN.md: Fixed English link to ../README.md
  • docs/README-ZH_HANS.md: Fixed English link to ../README.md

Content Updates

  • docs/CONTRIBUTING.md: Added README-ZH_HANS.md to sync checklist

New Features

  • scripts/sync-agents.sh: New sync script for AGENTS.md
  • .git/hooks/pre-commit: Git hook for automatic sync to internal_docs submodule
  • docs/CONTRIBUTING.md: Added AGENTS.md sync documentation

Workflow

AGENTS.md is now:

  • Kept out of git tracking (via .gitignore)
  • Synced to internal_docs/pixelclock/ via scripts/sync-agents.sh
  • Automatically synced on commit via pre-commit hook

Testing

  • All path references verified working
  • Sync script tested and functional

- Fix English link paths in README-ZH_CN.md and README-ZH_HANS.md
- Fix GitHub Actions document paths in GITHUB_ACTIONS.md
- Add README-ZH_HANS.md to CONTRIBUTING.md sync checklist
- Add scripts/sync-agents.sh for AGENTS.md sync mechanism
@chinaestone chinaestone merged commit a659245 into master Jan 10, 2026
1 check passed
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.

2 participants