Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Doc links take nowhere

クローズ
#128 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
30/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
python
領域
documentation

調査の方向性

まず、README にあるドキュメントリンク、litModels の PyPI ページ、および lightning.Trainer オブジェクトによって出力されるヒントを確認します。このプロジェクトにサポートされているドキュメントの場所があるか、または参照を削除すべきかを判断します。残ったリンクが関連するプロジェクトドキュメントに解決されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation

I got a hint printed when running a lightning.Trainer object, which sent me to the PyPi page for litModels. There is a link to documentation there which points to the non-existing https://lightning-ai.github.io/litModels/

Coming to the repo here in GitHub, the "Docs" link in the readme points at
https://lightning.ai/docs/overview/model-registry

which also doesn't seem to exist, and redirects to the "getting started" documentation for pytorch lightning.

I find it very bad manners to use one product to advertise another, and I find it particularly annoying when said advertised product is not even properly documented. Please set a proper documentation place for this project, or otherwise stop plugging it into other projects until there is a reasonable way of reading what the suggestion is about.

主要言語
Python
スター
40
フォーク
9
平均マージ
5日 19時間
マージ済み PR(30日)
4

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Lightning-AI/LitModels のほかの issue

Lightning-AI/LitModels の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。