Skip to content

docs: decode public Markdown link destinations - #4722

Open
dajiaohuang wants to merge 1 commit into
VisActor:developfrom
dajiaohuang:docs/issue-4658-external-hrefs-qitem-20261022
Open

dajiaohuang wants to merge 1 commit into
VisActor:developfrom
dajiaohuang:docs/issue-4658-external-hrefs-qitem-20261022

Conversation

@dajiaohuang

Copy link
Copy Markdown
Contributor

🤔 This is a ...

  • Site / documentation update

🔗 Related issue link

Related to #4658 (partial coverage; this PR intentionally does not close the issue)

💡 Background and solution

The captured issue describes 190 Markdown link destinations that encode the entire URL. This change decodes only the 169 destinations whose hosts are public external services, across 62 files. It leaves all 21 visactor.bytedance.net destinations unchanged rather than guessing public replacements. Those internal references need a verified public destination or an explicit removal decision before they can be changed.

📝 Changelog

Language Changelog
🇺🇸 English Restore absolute Markdown hrefs for 169 public external links; leave 21 internal-host references for a separate verified decision.
🇨🇳 Chinese 修复169个公开外部链接的Markdown目标地址;21个内部域名链接保留,等待确认公开替代地址或删除决定。

☑️ Self-Check before Merge

  • Documentation updated
  • Demo not applicable
  • TypeScript definitions not applicable
  • Changelog provided

Validation: compared the full diff with a deterministic one-layer URL decode of only non-internal destinations. Verified 62 changed files, 169 rewrites, exactly 21 encoded internal destinations remaining, and no non-internal encoded destinations left. git diff --check passed with the checkout’s CRLF setting (core.whitespace=cr-at-eol). The website build was not run.

@github-actions github-actions Bot added the docs label Oct 22, 2026

@xile611 xile611 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

审查基于 f1979dc。整体修改方向合理,未发现阻断合并的代码问题;有一处中英文共有的解码遗漏,见行内意见。

验证结果:

  • 使用 Node.js 22 和项目的 markdown-it 解析器核对全部 62 个修改文件,确认 169 处 href 变为绝对链接,链接数量和其余 Markdown token 内容保持不变。
  • 仍有 21 个整段编码的链接目标,全部指向 visactor.bytedance.net。将这些链接留待确认公开替代地址后处理是合理的,建议继续保留 #4658 跟踪。
  • git diff --check 在 core.whitespace=cr-at-eol 下通过。
  • GitHub TEST CI 的构建和单元测试通过。size 检查失败:产物 2.42 MB,限制 2 MB,超出 422.45 kB。本 PR 仅修改 Markdown,未发现能导致包体积增长的改动,但尚未通过基线复跑确认失败原因。

验证范围:未运行网站完整构建、图表视觉回归,也未逐一验证外部站点可达性及锚点定位。当前 GitHub 状态为 BLOCKED / REVIEW_REQUIRED,仍需审查批准。

* [github](https%3A%2F%2Fgithub.com%2FVisActor%2FVChart)</br>
* [轴配置文档](https%3A%2F%2Fvisactor.com%2Fvchart%2Foption%2FlineChart-axes-linear%23tick.tickMode('average'%257C'd3')%2520%3D%2520'average')</br> No newline at end of file
* [github](https://github.com/VisActor/VChart)</br>
* [轴配置文档](https://visactor.com/vchart/option/lineChart-axes-linear#tick.tickMode('average'%7C'd3')%2520%3D%2520'average')</br> No newline at end of file

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

非阻断建议:这里的 URL 没有完整完成一层解码。原目标尾部 %2520%3D%2520'average' 解码一次应为 %20=%20'average',当前仍保留原编码;英文同名文件第 92 行也存在相同情况。因此这两处与 PR 描述中的 deterministic one-layer URL decode 不完全一致。建议补齐这两处尾部解码并重新核对;如果是有意保留,请说明理由并调整验证描述。当前已确认链接能解析为绝对地址,尚未验证这个差异对官网锚点定位的实际影响。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants