Cross link in Quick Start guide more to other resources (like plugins)

Abierto
#987 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
55/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado

Línea de trabajo

The Quick Start guide and open images guide are named in the issue; find their source files in the documentation tree and read how they currently describe opening image files and plugin readers. Add a cross link with wording that introduces plugin readers and the supported example formats. Done means the Quick Start guide links to the open images guide with clear wording.

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

Descripción

I actually quite like the idea for linking to the documentation.

  1. We don't have to maintain two places (like we failed to here)
  2. It gives more detail on what is actualyl going on, especially if someone is in quickstart they don't even really necessarily know what a plugin is yet

Something like "To read additional file formats (e.g. .lif, .czi, .nd2), read more about using plugin readers in the open images guide"

I'm not super keen on that language so hopefully you can figure it out :)

Originally posted by @TimMonko in https://github.com/napari/docs/issues/976#issuecomment-4172169914

Lenguaje dominante
Makefile
Estrellas
13
Forks
71
Merge medio
3 d 8 h
PR fusionados (30 d)
31

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 napari/docs

Todos los issues de napari/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.