Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Doc links take nowhere

Cerrado
#128 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
30/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
python

Línea de trabajo

Comienza comprobando los enlaces de documentación en el README, la página de PyPI de litModels y la indicación que muestra un objeto lightning.Trainer. Determina si este proyecto tiene una ubicación de documentación compatible o si se deben eliminar las referencias; se considera terminado cuando los enlaces restantes llevan a documentación relevante del proyecto.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
40
Forks
9
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Lightning-AI/LitModels

Todos los issues de Lightning-AI/LitModels

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.