nushell / nushell/nushell.github.io

Use cookbook to explain some nu_scripts

Ouverte
#311 0 commentaires 5 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

documentation enhancement
Langage dominant
TypeScript
Étoiles
258
Forks
561
Merge moyen
3 h 20 min
PR mergées (30 j)
15

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner les pages existantes du cookbook et le dépôt nu_scripts associé afin de comprendre la couverture actuelle. Identifiez un script approprié et élaborez un guide détaillé du cookbook à son sujet. Le travail est terminé lorsqu’une page pratique a été ajoutée pour expliquer le script et fournir un guide approfondi, tout en améliorant la documentation du script traité.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Domaine
content, documentation
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.