Open
[1.0] 文档站:VitePress 接入 continew.top #12
Charles7cAdd on  8 days ago
Charles7c
Charles7cCollaborators
8 days ago Create

提交前确认

功能描述

README Roadmap 列明「文档站:VitePress 接入 continew.top」。脚手架的可采用性一半靠文档,1.0 GA 需要一个公开的、与仓库行为一致的文档站。目标版本 1.0.0。

建议方案

  1. VitePress 站点骨架,部署到 continew.top 子路径(与社区文档站整合)。
  2. 内容收口:快速开始、架构与红线说明、Cm* 组件文档、组合式函数文档、更新日志。
  3. 文档中的命令与脚本从仓库实际配置核对(呼应 #5 的「命令与当前脚本、CI 一致」)。
  4. 部署流水线随默认分支(dev)自动发布。

备选方案

方案 结论
只靠 GitHub README ❌ 中文社区生态需要独立文档站
自建文档框架 ❌ 无差异化价值,VitePress 足够
组件 API 全自动生成 ❌ 类型注释覆盖率不足时先人工核对

附加信息

验收标准

依赖

依赖 #5 文档收口(先有内容再上站);#1 汇总。

likedislike
Charles7cCharles7cCollaborators
8 days ago Associated milestone: 1.0.0
Charles7cCharles7cCollaborators
8 days ago Added label: documentationp1roadmap
Charles7cCharles7cCollaborators
8 days ago Modify description of issue