nushell / nushell/nushell.github.io

Move Philosophy into Book

Ouverte
#211 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

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

Description

The book does a great job on the How. It explains well how Nushell works. But it lacks a bit on the Why. The Introduction hints on it but it seems to get lost on the surface, e.g. "modern style of development", "modern feel", "UX polish". New users tend to want to know the Why first before the How.

The Philosophy section of the Contributor Book does a great job on the Why. But it's usually read only long after the How and only by people interested in the underlying details.

I'd like to propose moving the Why before the How. This means moving the Philosophy section into the main book before any concrete "Usage" sections. It would probably make sense to put it just after the Installation section.

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

Comparer la section Philosophy du Contributor Book avec la structure du livre principal, en particulier les sections Installation et Usage. Déplacer Philosophy dans le livre principal après Installation et avant les sections Usage concrètes ; terminé lorsque le Why est présenté avant le How et que l’ancien emplacement dans le Contributor Book est traité.

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

Évaluation

Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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