loopbackio / loopbackio/loopback.io
Missing documentation of DefaultCrudRepository
まだ誰も着手していません。
- 主要言語
- HTML
- スター
- 276
- フォーク
- 382
- 平均マージ
- 6時間 17分
- マージ済み PR(30日)
- 18
説明
URL of the page
https://loopback.io/doc/en/lb4/
Nature of the issue
There is no API documentation for DefaultCrudRepository which is a key class.
The only place where it can be found is:
https://marioestradarosa.github.io/loopback.io/doc/en/lb4/apidocs.repository.defaultcrudrepository.html
Expected behavior
I expect to find the API documentation by searching for DefaultCrudRepository or by browsing to:
https://loopback.io/doc/en/lb4/apidocs.index.html
but here the entire @loopback/repository
is missing.
Actual behavior
When I search DefaultCrudRepository it finds 5 references but not the API specification.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず LB4 API ドキュメントのインデックスと、issue でリンクされている @loopback/repository のページを確認し、その後、公開されたドキュメントで DefaultCrudRepository がどのように掲載されているかを検証します。完了条件は、DefaultCrudRepository の API 仕様と @loopback/repository の残りの内容がインデックスから到達でき、ドキュメントサイトで検索できることです。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100