Skip to content

docs(roadmap): fix dead Contributing link (404) in EN+ZH roadmap#2322

Merged
qin-ctx merged 1 commit into
volcengine:mainfrom
r266-tech:docs-roadmap-contributing-link-404
Jun 4, 2026
Merged

docs(roadmap): fix dead Contributing link (404) in EN+ZH roadmap#2322
qin-ctx merged 1 commit into
volcengine:mainfrom
r266-tech:docs-roadmap-contributing-link-404

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Problem

Both roadmap pages invite contributions, but the Contributing link 404s:

  • docs/en/about/03-roadmap.md L115 — See [Contributing](contributing.md) for guidelines.
  • docs/zh/about/03-roadmap.md L115 — 请参阅 [贡献指南](contributing.md)。

Each link resolves relative to docs/{en,zh}/about/docs/{en,zh}/about/contributing.md, which does not exist anywhere in the repo tree. The contribution guidelines actually live at the repo root (CONTRIBUTING.md / CONTRIBUTING_CN.md). A contributor who follows the roadmap's "We welcome contributions … See Contributing" call-to-action hits a dead page.

Fix

Retarget each link to the canonical root file via its GitHub blob URL — the same convention README.md already uses for root-level repo resources (e.g. the LICENSE badge → .../blob/main/LICENSE):

  • EN → https://github.com/volcengine/OpenViking/blob/main/CONTRIBUTING.md
  • ZH → https://github.com/volcengine/OpenViking/blob/main/CONTRIBUTING_CN.md

Pure docs, 2 lines, no content change beyond the link target. Restores the contribution funnel on a stable nav page.

Retarget [Contributing](contributing.md) -> root CONTRIBUTING.md / CONTRIBUTING_CN.md GitHub blob URL; the docs/{en,zh}/about/contributing.md target does not exist.
@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 100
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@qin-ctx qin-ctx merged commit bebfa7d into volcengine:main Jun 4, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project Jun 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants