nushell / nushell/nushell.github.io

Add see-also section to command docs for better discoverability

Offen
#1,029 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

The command docs are fantastic. I'm a new user and find myself using help foo constantly and learning a ton from the examples. However, discoverability is still an issue for me. When I realize that enter is the way to "pushd", I have no idea that shells is the way to see them (traditional "dirs"). It'd be really helpful if there was some cross-referencing in the help outputs, probably below the Examples: section.

I would be up for trying (a PR) to add a bunch of See also: sections to the commands references (.md). But want to make sure you folks are on board with the idea before putting time into it.

The motivation for this is what's seen in the Clojure docs (similar to how a single web doc resource is exported into editor tooling (cider etc)): https://clojuredocs.org/clojure.core/reduce
The "SEE ALSO" section there near the bottom (and on all the similar docs) is very useful.

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 Befehlsreferenzdateien (.md) zu lokalisieren und zu prüfen, wie die aktuellen Help-Ausgaben ihre Examples-Abschnitte darstellen. Füge unterhalb dieser Beispiele die vereinbarten Querverweise hinzu, wobei die Beziehung zwischen enter und shells als Beispiel dient. Als erledigt gilt die Aufgabe, wenn die relevanten Befehlsdokumentationen durchgängig nützliche See also-Abschnitte enthalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
markdown
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
40/100

Neue Issues direkt in Ihr Postfach

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