nushell / nushell/nushell.github.io

Use cookbook to explain some nu_scripts

Offen
#311 0 Kommentare 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

documentation enhancement
Vorherrschende Sprache
TypeScript
Sterne
258
Forks
561
Ø Merge
3 Std. 20 Min.
Gemergte PRs (30 T.)
15

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die vorhandenen Cookbook-Seiten und das verknüpfte Repository nu_scripts zu prüfen, um den aktuellen Abdeckungsumfang zu verstehen. Identifiziere ein geeignetes Skript und entwirf dafür einen detaillierten Cookbook-Leitfaden. Erledigt ist die Aufgabe, wenn eine praxisorientierte Seite hinzugefügt wurde, die das Skript erklärt und eine ausführliche Anleitung bietet, während zugleich die Dokumentation für das behandelte Skript verbessert wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
content, documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.