SuperAPI AI 工具集

hns-oss-docs-structure-map

写作与研究

查看项目

更新于 10-16 06:48

技能介绍

用途:为 oss-docs harness 的 structure-curator 提供 docs-site 站点的结构说明,标明关键文件路径与数据模式。

主要路径:站点配置为 docs-site/hugo.toml(不是 hugo.yaml,defaultContentLanguage 为 ko,版本以 params.version / params.releaseDate 为准);内容位于 content/{ko,en,ja,zh}/,ko 为规范版本,四语言树互相对应;各区段顺序见 content/<locale>/_meta.yaml,改动一个区段需同步四个文件;侧边栏菜单位于 data/menu/main.yaml,每项含四语言名称映射和 icon;菜单图标在 layouts/partials/menu.html;短代码在 layouts/shortcodes/;CSS 为 static/moai-brand.css(冻结,不可编辑)和 static/moai-design.css;重定向在 vercel.json 的 redirects 数组。

用法与约束:main.yaml 每个条目需四语言名称映射、ref 与 icon。icon 值与 menu.html 中的 SVG switch/case 必须匹配,否则静默渲染空 svg 且无构建警告,编辑后用 grep -n '"<icon-value>"' docs-site/layouts/partials/menu.html 检查,缺失则同步补 case。页面移动或重命名需同时写两条 redirects(带 locale 与不带 locale 各一)。验证构建:cd docs-site && hugo --minify --gc 须无警告通过;完整流程见 Skill("hns-oss-docs-verify")。

已知差异:content/<locale>/_meta.yaml 含 design 区段而 data/menu/main.yaml 含 guides,修改时需按 SSOT 设计报告(.moai/reports/readme-docs-redesign-20260713.md)的 12→11 区段重构对齐,并在报告中记录处理方向。旧 i18n 规则文档提到的 gen_menu.py 并不存在,菜单只能手动编辑。