Skip to content

fix(docs): correct broken path references in contributing docs#3137

Merged
theonlyhennygod merged 1 commit intozeroclaw-labs:masterfrom
Guanzhw:docs/fix-path-references
Mar 11, 2026
Merged

fix(docs): correct broken path references in contributing docs#3137
theonlyhennygod merged 1 commit intozeroclaw-labs:masterfrom
Guanzhw:docs/fix-path-references

Conversation

@Guanzhw
Copy link
Copy Markdown

@Guanzhw Guanzhw commented Mar 10, 2026

Summary

Describe this PR in 2-5 bullets:

  • Base branch target (master for all contributions): master
  • Problem: Several files in docs/contributing/ referenced other docs files using incorrect paths like "docs/pr-workflow.md" when files are actually in the same directory
  • Why it matters: Broken link text confuses contributors trying to navigate documentation
  • What changed: Fixed path references in 6 files (15 lines total) - removed incorrect "docs/" prefix from link text
  • What did not change (scope boundary): No actual content changes, only link text corrections

Label Snapshot (required)

  • Risk label (risk: low|medium|high): low
  • Size label (size: XS|S|M|L|XL, auto-managed/read-only): XS
  • Scope labels (core|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 labels (<module>: <component>, for example channel: telegram, provider: kimi, tool: shell): docs: general
  • Contributor tier label (trusted contributor|experienced contributor|principal contributor|distinguished contributor, auto-managed/read-only; author merged PRs >=5/10/20/50):
  • If any auto-label is incorrect, note requested correction: N/A

Change Metadata

  • Change type (bug|feature|refactor|docs|security|chore): docs
  • Primary scope (runtime|provider|channel|memory|security|ci|docs|multi): docs

Linked Issue

  • Closes #: N/A
  • Related #: N/A
  • Depends on # (if stacked): N/A
  • Supersedes # (if replacing older PR): N/A

Supersede Attribution (required when Supersedes # is used)

  • Superseded PRs + authors (#<pr> by @<author>, one per line): N/A
  • Integrated scope by source PR (what was materially carried forward): N/A
  • Co-authored-by trailers added for materially incorporated contributors? (Yes/No): Yes
  • If No, explain why (for example: inspiration-only, no direct code/design carry-over): N/A
  • Trailer format check (separate lines, no escaped \n): (Pass/Fail): Pass

Validation Evidence (required)

Commands and result summary:

npx --yes markdownlint-cli2@0.20.0 [changed files]
# Result: Summary: 0 error(s)
  • Evidence provided (test/log/trace/screenshot/perf): markdownlint passed with 0 errors
  • If any command is intentionally skipped, explain why: N/A

Security Impact (required)

  • New permissions/capabilities? (Yes/No): No
  • New external network calls? (Yes/No): No
  • Secrets/tokens handling changed? (Yes/No): No
  • File system access scope changed? (Yes/No): No
  • If any Yes, describe risk and mitigation: N/A

Privacy and Data Hygiene (required)

  • Data-hygiene status (pass|needs-follow-up): pass
  • Redaction/anonymization notes: None needed
  • Neutral wording confirmation (use ZeroClaw/project-native labels if identity-like wording is needed): Confirmed

Compatibility / Migration

  • Backward compatible? (Yes/No): Yes
  • Config/env changes? (Yes/No): No
  • Migration needed? (Yes/No): No
  • If yes, exact upgrade steps: N/A

i18n Follow-Through (required when docs or user-facing wording changes)

  • i18n follow-through triggered? (Yes/No): Yes
  • If Yes, locale navigation parity updated in README*, docs/README*, and docs/SUMMARY.md for supported locales (en, zh-CN, ja, ru, fr, vi)? (Yes/No): Yes (fixed Vietnamese docs, no content change)
  • If Yes, localized runtime-contract docs updated where equivalents exist (minimum for fr/vi: commands-reference, config-reference, troubleshooting)? (Yes/No/N.A.): N.A. (no runtime-contract changes)
  • If Yes, Vietnamese canonical docs under docs/i18n/vi/** synced and compatibility shims under docs/*.vi.md validated? (Yes/No/N.A.): Yes (fixed Vietnamese contributing docs)
  • If any No/N.A., link follow-up issue/PR and explain scope decision: N/A

Human Verification (required)

What was personally validated beyond CI:

  • Verified scenarios: Markdown lint passes, linked files exist
  • Edge cases checked: N/A
  • What was not verified: Full link check (lychee unavailable locally)

Side Effects / Blast Radius (required)

  • Affected subsystems/workflows: Documentation only
  • Potential unintended effects: None
  • Guardrails/monitoring for early detection: N/A

Agent Collaboration Notes (recommended)

  • Agent tools used (if any): Claude Code
  • Workflow/plan summary (if any): Found 6 files with inconsistent path references, fixed by removing incorrect "docs/" prefix
  • Verification focus: Markdown lint
  • Confirmation: naming + architecture boundaries followed (AGENTS.md + CONTRIBUTING.md): Confirmed

Rollback Plan (required)

  • Fast rollback command/path: git revert <commit>
  • Feature flags or config toggles (if any): None
  • Observable failure symptoms: None expected

Risks and Mitigations

List real risks in this PR (or write None).

  • Risk: None
    • Mitigation: N/A

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated internal documentation links across contributing guides, workflow documentation, and setup guides to improve link navigation consistency.

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>
@Guanzhw Guanzhw requested a review from JordanTheJet as a code owner March 10, 2026 16:41
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 10, 2026

Note

.coderabbit.yaml has unrecognized properties

CodeRabbit is using all valid settings from your configuration. Unrecognized properties (listed below) have been ignored and may indicate typos or deprecated fields that can be removed.

⚠️ Parsing warnings (1)
Validation error: Unrecognized key(s) in object: 'tools', 'path_filters', 'review_instructions'
⚙️ Configuration instructions
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: d2d34a9b-cc7c-4007-aece-c33b5d7619b7

📥 Commits

Reviewing files that changed from the base of the PR and between 046040d and 7ee9ea5.

📒 Files selected for processing (6)
  • docs/contributing/README.md
  • docs/contributing/pr-workflow.md
  • docs/contributing/reviewer-playbook.md
  • docs/i18n/vi/contributing/README.md
  • docs/setup-guides/zai-glm-setup.md
  • docs/vi/contributing/README.md

📝 Walkthrough

Walkthrough

This PR updates cross-reference links across English and Vietnamese documentation directories by converting absolute or docs-prefixed paths to relative paths. Changes span six files in contributing and setup-guides directories.

Changes

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.mdpr-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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@theonlyhennygod theonlyhennygod self-assigned this Mar 11, 2026
@theonlyhennygod theonlyhennygod requested review from theonlyhennygod and removed request for JordanTheJet March 11, 2026 07:30
@theonlyhennygod theonlyhennygod merged commit 980ad7e into zeroclaw-labs:master Mar 11, 2026
7 checks 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