Automatically update gh-pages after Documentation and examples have been committed
未关闭
还没有人认领这个 Issue。
documentation
enhancement
- 主要语言
- TypeScript
- 星标
- 153
- 派生
- 46
- 平均合并
- 1 天 8 小时
- 30 天内合并 PR
- 7
描述
Currently there seems to be a lack of automatic update of gh-pages when new documentation is added. We also need to generate the API documentation using npm run doc for gh-pages, since I think it's bad practice to commit files that are automatically generated anyway.
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先定位 gh-pages 发布工作流以及文档和示例的构建入口。运行 npm run doc 以了解生成的 API 文档,然后验证文档更改会触发 gh-pages 更新,同时不提交生成的文件。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- typescript
- 领域
- ci-cd, documentation
- Issue 类型
- 功能
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100