Skip to content

refactor: OEM 更新日志章节目录改用中性名,消除站点 JS 里的品牌字眼 - #59

Merged
yi-ge merged 1 commit into
mainfrom
refactor/oem-changelog-neutral-dir
Sep 19, 2026
Merged

yi-ge merged 1 commit into
mainfrom
refactor/oem-changelog-neutral-dir

Conversation

@yi-ge

@yi-ge yi-ge commented Sep 19, 2026

Copy link
Copy Markdown
Member

变更说明 / Description

中文

  • OEM 更新日志章节目录改用中性名 12-oem-changelog(中英),urlPrefix 改为 /more/oem-changelog,封面目录改为 static/img/changelog/oem
  • 原因:Docusaurus 会把草稿的 doc id(由目录名决定)写进站点 JS 的 draftIds。改用中性目录名后,草稿页面在站点产物里不再留下任何第三方品牌字眼。
  • 发行版 id 与接口文件名(changelog-<id>.json)是客户端读取接口的约定,保持不变;OEM 发布流程从本配置读取目录,主仓无需改动。
  • 在配置描述里补充规则:章节目录名、urlPrefix 与封面目录要用中性名。

English

  • Rename the OEM changelog section directories to the neutral name 12-oem-changelog (zh + en), set urlPrefix to /more/oem-changelog and the cover directory to static/img/changelog/oem.
  • Why: Docusaurus writes the ids of draft docs (derived from the directory name) into the site's JS as draftIds. With a neutral directory name, draft pages leave no third-party brand text in the site output at all.
  • The edition id and the API file name (changelog-<id>.json) are the contract the client reads, so they stay unchanged; the OEM release workflow reads the directories from this config, so the main repository needs no change.
  • The config description now documents the rule: section directory names, urlPrefix and cover directories must use neutral names.

测试方式 / Test Plan

  • 对最小站点跑真实的 Docusaurus 3.9.2 生产构建:草稿态构建成功,产物里含第三方品牌字眼的文件为 0 个,draftIds 为中性的 more/oem-changelog/...;公开态构建成功,实际路由 /more/oem-changelog/... 与接口里的 url、封面地址一致 / Real Docusaurus 3.9.2 production builds of a minimal site: the draft build succeeds with 0 output files containing third-party brand text and neutral draftIds (more/oem-changelog/...); the published build succeeds and the real routes /more/oem-changelog/... match the url and cover URLs in the API.
  • 全库已无旧目录名的引用 / No references to the old directory names remain.

检查清单 / Checklist

章节目录、urlPrefix 与封面目录不再含第三方品牌字眼:Docusaurus 会把草稿的 doc id(由目录名决定)
写进站点 JS 的 draftIds,用中性目录名后,草稿页面在站点产物里不再留下任何品牌字眼。
发行版 id 与接口文件名(changelog-<id>.json)是客户端读取接口的约定,保持不变;发布流程从本配置读取目录,无需改动。
@vercel

vercel Bot commented Sep 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Sep 19, 2026 11:47am UTC

Request Review

@yi-ge
yi-ge merged commit 478266d into main Sep 19, 2026
3 checks passed
@yi-ge
yi-ge deleted the refactor/oem-changelog-neutral-dir branch September 19, 2026 11:48
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.

1 participant