nushell / nushell/nushell.github.io

Use cookbook to explain some nu_scripts

Aperta
#311 0 commenti 5 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation enhancement
Lingua principale
TypeScript
Stelle
258
Fork
561
Merge medio
3h 20m
PR unite (30g)
15

Descrizione

Currently, the cookbook is rather underwhelming. The idea of the cookbook is to show practical recipes and how-to guides with explanations. One idea how to add more content is to take some nice script from nu_scripts and go through it in detail in a cookbook page. This has two benefits:

  1. Enhanced in-depth documentation for scripts in nu_scripts
  2. More cookbook content

Of course, we can think of other scripts to add to nu_scripts that would be interesting to cover in the cookbook.

Guida per i contributori

Apri la 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.

Direzione di ricerca

Inizia esaminando le pagine esistenti del cookbook e il repository nu_scripts collegato per comprendere la copertura attuale. Individua uno script adatto e prepara una guida dettagliata del cookbook su di esso. Il lavoro è completo quando è stata aggiunta una pagina pratica che spiega lo script e fornisce una guida approfondita, migliorando al contempo la documentazione dello script trattato.

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

Valutazione

Ambito
content, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.