Add see-also section to command docs for better discoverability

オープン

#1,029 2023年8月29日に作成コメント 1 件リアクション 0 件担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度: 3/5
見積もり時間: 1〜2日
初心者へのやさしさ: 40/100

issue の種類: ドキュメント
明瞭さ: おおむね明確
活発さ: 停滞
技術スタック: markdown
領域: documentation

調査の方向性

まずコマンドリファレンスの (.md) ファイルを見つけ、現在の help 出力で Examples セクションがどのように示されているかを確認します。enter と shells の関係を例として、合意済みの相互参照をそれらの例の下に追加します。関連するコマンドドキュメントに有用な See also セクションが一貫して含まれていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語: TypeScript
スター: 258
フォーク: 561
平均マージ: 3時間 20分
マージ済み PR（30日）: 15

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
リポジトリをフォークし、ブランチを切って変更します。
issue 番号を参照したプルリクエストを送ります。

nushell/nushell.github.io のほかの issue

`--log-level` isn't documented in documentation for flags オープン

難易度 1/5 1〜3時間初心者へのやさしさ 68/100

nushell/nushell.github.io#2081 · コメント 3 件 · 2025年11月25日に作成
[ja] fix statement about lines output type オープン

難易度 1/5 1時間未満初心者へのやさしさ 62/100

nushell/nushell.github.io#767 · コメント 1 件 · 2023年2月4日に作成
The cookbook example "Accessing HTTP Response Metadata While Streaming" doesn't stream オープン

難易度 3/5 1〜2日初心者へのやさしさ 58/100

nushell/nushell.github.io#2232 · コメント 1 件 · 2026年8月24日に作成
Color scheme toolbar button does not apply to code samples オープン

難易度 3/5 1〜2日初心者へのやさしさ 58/100

nushell/nushell.github.io#2209 · 2026年7月19日に作成
Pages won't load after a period of time オープン

難易度 4/5 3〜5日初心者へのやさしさ 45/100

nushell/nushell.github.io#2194 · 2026年7月5日に作成

nushell/nushell.github.io の issue をすべて見る

似ている issue

ls -i / --inode not supported ("invalid option -- i"), breaks autoconf's `ls -di .` working-directory check オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

vercel-labs/just-bash#464 · 2026年9月24日に作成
looksLikeSlug() is ASCII-only, so non-Latin entity slugs (e.g. Korean) skip exact match and collapse オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

garrytan/gbrain#5421 · 2026年9月24日に作成
Passer le formulaire de publication en BAL 1.5 par défaut オープン

難易度 2/5 1〜3時間初心者へのやさしさ 65/100

BaseAdresseNationale/adresse.data.gouv.fr#2583 · 2026年9月24日に作成
🎙️ task - fix(tests-node): the shipped catch ships cause error where error is unknown オープン

難易度 2/5 1〜3時間初心者へのやさしさ 65/100

ehmpathy/declapract-typescript-ehmpathy#632 · 2026年9月24日に作成
Search modal renders beneath the open AI dock (shared --z-overlay) オープン

難易度 1/5 1時間未満初心者へのやさしさ 90/100

TanStack/tanstack.com#1293 · 2026年9月24日に作成

TypeScript の issue をもっと見る