Skip to content

Commit d0c96e2

Browse files
committed
docs: migrate deployment & config guides from MD to HTML
Convert two user-maintained docs to semantic HTML5 with embedded CSS. Add AGENTS.md policy preferring HTML for new user-maintained docs. Upstream-fork .md files remain untouched.
1 parent e142051 commit d0c96e2

5 files changed

Lines changed: 1176 additions & 888 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
- `docs/CHANGELOG.md``[Unreleased]` 段使用**扁平格式**:每条独立一行,格式为 `- [类型] 描述`,类型取值:`新功能`/`改进`/`修复`/`文档`/`测试`/`chore`**禁止在 `[Unreleased]` 内新增 `### 类目标题`**,以减少并发 PR 的 merge 冲突。发版时由 maintainer 汇总整理成带标题的正式格式。
2222
- `README.md` 只用于项目定位、核心能力总览、快速开始、主要入口、赞助/合作等首页级信息;非必要不更新 README,避免持续膨胀。
2323
- 更细的模块行为、页面交互、专题配置、排障说明、字段契约、实现语义和边界条件,优先更新对应 `docs/*.md` 或专题文档,不写入 README。
24+
- **新增用户自维护的技术文档**(部署指南、配置指南、专题说明书等)优先使用 HTML 格式:语义化 HTML5 + 内嵌 `<style>`,不使用外部 CSS/JS 依赖。HTML 提供一致的跨平台渲染、原生 `<details>` 折叠、CSS 提示框组件、更明确的 DOM 结构便于 AI 工具解析与 diff 审核。上游 fork 同步的 `.md` 文档保持原格式不动,不转换。
2425
- 变更中英双语文档之一时,需评估另一份是否需要同步;若未同步,交付说明里要写明原因。
2526
- 注释、docstring、日志文案以清晰准确为准,不强制要求英文,但应与文件语境保持一致。
2627

0 commit comments

Comments
 (0)