Skip to content

docs(about): command-first overview lede #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AMDphreak merged 1 commit into from
Sep 29, 2026
Merged

docs(about): command-first overview lede #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ For longer narratives, see link:changelog-details/[changelog-details/] (when pre
== Timeline

* 2026-09-29 — Antora: register under shared `tools` component (`about` module); rewrite overview lede for machine-orientation CLI.
* 2026-09-29 — Docs: open overview with `` `about` `` as a CLI command in loose prose (Nushell-optional behavior unchanged).
* 2026-07-25 — link:changelog-details/2026-07-25%20-%20command%20orientation%20cards.adoc[Command orientation cards] — `about <cmd>`, tip crosslinks to help/info/man.
* 2026-07-24 — link:changelog-details/2026-07-24%20-%20nushell-aware%20output.adoc[Nushell-aware output] — Nu tip sheet, classic-shell nudge, `--format nuon`.
* 2026-07-23 — link:changelog-details/2026-07-23%20-%20initial%20about%20cli.adoc[Initial `about` CLI] — native + Cosmopolitan APE builds, CI release pipeline.
7 changes: 4 additions & 3 deletions docs/modules/about/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@
:page-last-author: cursor-agent on behalf of amdphreak
:page-last-edited: 2026-09-29

`about` is a portable CLI that prints machine orientation (OS, shell, environment) and a short OS-family cheat sheet for looking around.
Under https://www.nushell.sh/[Nushell], the cheat sheet uses `nu` idioms (`sys`, `$env`, `ls`, …).
Outside Nushell, you still get the full classic tip sheet — plus a nudge to install `nu`.
`about` is a command for the CLI that orients you on a machine you didn't set up — OS, shell, environment, and a short cheat sheet of ways to look around on that OS family.

When you're in https://www.nushell.sh/[Nushell], those tips speak `nu` (`sys`, `$env`, `ls`, …).
When you're not, you still get the full classic tip sheet, plus a nudge to install `nu`.
Nushell is never required; `about` always runs.

== Why
Expand Down
Loading