nushell/nushell

Idea: `help about` subcommand

Open

#9,109 opened on May 5, 2023

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Rust (2,129 forks)batch import
A:help-systemA:std-librarycategory:documentationcategory:enhancementgood first issue

Repository metrics

Stars
 (39,478 stars)
PR merge metrics
 (Avg merge 4d 1h) (123 merged PRs in 30d)

Description

Related problem

Current Nu help doesn't have any explanation for core concepts you need to know to work with Nu: the various quotes for string literals, pipelines. These are explained in the book, but are not available at a command prompt.

Describe the solution you'd like

A help about subcommand with articles about general language concepts or syntax that aren't specific to one command or module. These articles should be discoverable through help --find, like other types of help content.

Describe alternatives you've considered

No response

Additional context and details

Based on Powershell, which has a series of about_* articles. Hopefully, Nu's equivalent would be a bit less pedantic and verbose.

Contributor guide

Research direction
Study the existing help command implementation in Nushell (crates/nu command/src/system/help.rs). Understand how subcommands are registered and how help content is displayed. Then, create a new `help about` subcommand that loads articles from markdown files or inline strings, and integrate it with the help system so it is discoverable via `help find`.
Tech stack
rust
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60