fix(docs): correct broken path references in contributing docs#3137
Conversation
Several files in docs/contributing/ referenced other docs files using incorrect paths like "docs/pr-workflow.md" when the files are actually in the same directory (docs/contributing/). Changes: - docs/contributing/README.md: fix Suggested Reading Order paths - docs/contributing/pr-workflow.md: fix link text references - docs/contributing/reviewer-playbook.md: fix link text reference - docs/vi/contributing/README.md: fix Vietnamese translation paths - docs/i18n/vi/contributing/README.md: fix Vietnamese i18n paths - docs/setup-guides/zai-glm-setup.md: fix custom-providers.md link Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Note
|
| Cohort / File(s) | Summary |
|---|---|
English Contributing Documentation docs/contributing/README.md, docs/contributing/pr-workflow.md, docs/contributing/reviewer-playbook.md |
Updated internal link references by removing docs/ prefix and converting to shorter relative paths (e.g., docs/pr-workflow.md → pr-workflow.md). |
Vietnamese Contributing Documentation docs/i18n/vi/contributing/README.md, docs/vi/contributing/README.md |
Converted absolute paths with docs/... prefix to relative paths using ../... notation for cross-file references. |
Setup Guides docs/setup-guides/zai-glm-setup.md |
Updated documentation reference link from absolute docs/custom-providers.md path to relative ../contributing/custom-providers.md path. |
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
- zeroclaw-labs/zeroclaw#2851: Modifies the same documentation files (pr-workflow.md, reviewer-playbook.md, ci-map.md) and updates cross-reference links
- zeroclaw-labs/zeroclaw#2928: Updates internal link targets/paths in CONTRIBUTING, pr-workflow, reviewer-playbook, ci-map and their i18n variants with potential overlap
Suggested labels
documentation, docs
Suggested reviewers
- theonlyhennygod
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | ✅ Passed | The title accurately describes the main change: fixing broken path references in contributing documentation by correcting link paths. |
| Description check | ✅ Passed | The PR description comprehensively follows the template with all required sections completed: Summary, Labels, Change Metadata, Linked Issues, Validation Evidence, Security Impact, Privacy/Data Hygiene, Compatibility, i18n Follow-Through, Human Verification, Side Effects, Rollback Plan, and Risks. |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
🧪 Generate unit tests (beta)
- Create PR with unit tests
- Post copyable unit tests in a comment
Tip
Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.
Summary
Describe this PR in 2-5 bullets:
masterfor all contributions): masterLabel Snapshot (required)
risk: low|medium|high): lowsize: XS|S|M|L|XL, auto-managed/read-only): XScore|agent|channel|config|cron|daemon|doctor|gateway|health|heartbeat|integration|memory|observability|onboard|provider|runtime|security|service|skillforge|skills|tool|tunnel|docs|dependencies|ci|tests|scripts|dev, comma-separated): docs<module>: <component>, for examplechannel: telegram,provider: kimi,tool: shell): docs: generaltrusted contributor|experienced contributor|principal contributor|distinguished contributor, auto-managed/read-only; author merged PRs >=5/10/20/50):Change Metadata
bug|feature|refactor|docs|security|chore): docsruntime|provider|channel|memory|security|ci|docs|multi): docsLinked Issue
Supersede Attribution (required when
Supersedes #is used)#<pr> by @<author>, one per line): N/ACo-authored-bytrailers added for materially incorporated contributors? (Yes/No): YesNo, explain why (for example: inspiration-only, no direct code/design carry-over): N/A\n): (Pass/Fail): PassValidation Evidence (required)
Commands and result summary:
npx --yes markdownlint-cli2@0.20.0 [changed files] # Result: Summary: 0 error(s)Security Impact (required)
Yes/No): NoYes/No): NoYes/No): NoYes/No): NoYes, describe risk and mitigation: N/APrivacy and Data Hygiene (required)
pass|needs-follow-up): passCompatibility / Migration
Yes/No): YesYes/No): NoYes/No): Noi18n Follow-Through (required when docs or user-facing wording changes)
Yes/No): YesYes, locale navigation parity updated inREADME*,docs/README*, anddocs/SUMMARY.mdfor supported locales (en,zh-CN,ja,ru,fr,vi)? (Yes/No): Yes (fixed Vietnamese docs, no content change)Yes, localized runtime-contract docs updated where equivalents exist (minimum forfr/vi:commands-reference,config-reference,troubleshooting)? (Yes/No/N.A.): N.A. (no runtime-contract changes)Yes, Vietnamese canonical docs underdocs/i18n/vi/**synced and compatibility shims underdocs/*.vi.mdvalidated? (Yes/No/N.A.): Yes (fixed Vietnamese contributing docs)No/N.A., link follow-up issue/PR and explain scope decision: N/AHuman Verification (required)
What was personally validated beyond CI:
Side Effects / Blast Radius (required)
Agent Collaboration Notes (recommended)
AGENTS.md+CONTRIBUTING.md): ConfirmedRollback Plan (required)
git revert <commit>Risks and Mitigations
List real risks in this PR (or write
None).🤖 Generated with Claude Code
Summary by CodeRabbit