Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Doc links take nowhere

已关闭
#128 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
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
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Lightning-AI/LitModels 的其他 Issue

查看 Lightning-AI/LitModels 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。