Automatically update gh-pages after Documentation and examples have been committed
オープン
まだ誰も着手していません。
documentation
enhancement
- 主要言語
- TypeScript
- スター
- 153
- フォーク
- 46
- 平均マージ
- 1日 8時間
- マージ済み PR（30日）
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、gh-pages の公開ワークフローと、ドキュメントおよびサンプルのビルドのエントリーポイントを見つけます。npm run doc を実行して生成される API ドキュメントを理解し、その後、生成されたファイルをコミットせずに、ドキュメントの変更によって gh-pages の更新がトリガーされることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- ci-cd, documentation
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100