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

Aperta
#987 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Makefile
Stelle
13
Fork
71
Merge medio
3g 8h
PR unite (30g)
31

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di napari/docs

Tutte le issue di napari/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.