Add see-also section to command docs for better discoverability
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 40/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- markdown
调研方向
首先定位命令参考 (.md) 文件，并查看当前的帮助输出如何呈现其 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
- 星标
- 260
- 派生
- 563
- 平均合并
- 4 小时 36 分钟
- 30 天内合并 PR
- 16
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
nushell/nushell.github.io 的其他 Issue
-
难度 1/5 1-3 小时 新手友好度 68/100
nushell/nushell.github.io#2081 · 3 条评论 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 62/100
nushell/nushell.github.io#767 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 58/100
nushell/nushell.github.io#2232 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 58/100
nushell/nushell.github.io#2209 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 45/100
nushell/nushell.github.io#2194 ·
维护者通常 1 天内回复
查看 nushell/nushell.github.io 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 2/5 1-3 小时 新手友好度 72/100
solana-foundation/solana-com#2245 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
`document.cookie` with `max-age=0` does not delete the cookie可能已有人在做 @BartInTheField 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 74/100
capricorn86/happy-dom#2460 ·
维护者通常 2 天内回复