From cabe1d7ba4c775d9445cf40c577f1896688e3523 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Tue, 29 Sep 2026 00:27:28 +0000 Subject: [PATCH 1/2] docs(antora): register about under tools component MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Move docs module ROOT → about; set component name/title to tools/Tools. Rewrite index lede so cold readers see machine-orientation CLI first; nav landing label matches H1 (about). Add page-context attrs. Co-authored-by: Ryan Johnson --- CHANGELOG.adoc | 1 + docs/antora.yml | 8 ++++---- docs/modules/{ROOT => about}/nav.adoc | 2 +- docs/modules/{ROOT => about}/pages/build.adoc | 0 docs/modules/{ROOT => about}/pages/index.adoc | 18 +++++++++++------- .../modules/{ROOT => about}/pages/nushell.adoc | 0 .../modules/{ROOT => about}/pages/related.adoc | 0 docs/modules/{ROOT => about}/pages/usage.adoc | 0 8 files changed, 17 insertions(+), 12 deletions(-) rename docs/modules/{ROOT => about}/nav.adoc (80%) rename docs/modules/{ROOT => about}/pages/build.adoc (100%) rename docs/modules/{ROOT => about}/pages/index.adoc (62%) rename docs/modules/{ROOT => about}/pages/nushell.adoc (100%) rename docs/modules/{ROOT => about}/pages/related.adoc (100%) rename docs/modules/{ROOT => about}/pages/usage.adoc (100%) diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index f058e1f..73ffcb7 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -7,6 +7,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-07-25 — link:changelog-details/2026-07-25%20-%20command%20orientation%20cards.adoc[Command orientation cards] — `about `, 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. diff --git a/docs/antora.yml b/docs/antora.yml index ded3328..1cbcfd2 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -1,6 +1,6 @@ -name: about -title: about +name: tools +title: Tools version: ~ -start_page: ROOT:index.adoc +start_page: about:index.adoc nav: - - modules/ROOT/nav.adoc + - modules/about/nav.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/about/nav.adoc similarity index 80% rename from docs/modules/ROOT/nav.adoc rename to docs/modules/about/nav.adoc index 87d09dd..4db24f0 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/about/nav.adoc @@ -1,4 +1,4 @@ -* xref:index.adoc[Overview] +* xref:index.adoc[about] * xref:usage.adoc[Usage] * xref:nushell.adoc[Nushell] * xref:build.adoc[Building] diff --git a/docs/modules/ROOT/pages/build.adoc b/docs/modules/about/pages/build.adoc similarity index 100% rename from docs/modules/ROOT/pages/build.adoc rename to docs/modules/about/pages/build.adoc diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/about/pages/index.adoc similarity index 62% rename from docs/modules/ROOT/pages/index.adoc rename to docs/modules/about/pages/index.adoc index e1069b4..13932af 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/about/pages/index.adoc @@ -1,7 +1,15 @@ = about -:description: Orient yourself — OS, shell, and how to look around. - -One command to answer: *what machine is this, and how do I look around?* +:description: Portable CLI for machine orientation — OS, shell, environment, and how to look around. +:page-audience: operators and developers who land on unfamiliar machines +:page-usage-context: reference for building, running, and interpreting output from the `about` CLI +:page-orig-author: OpenShellOrg +: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`. +Nushell is never required; `about` always runs. == Why @@ -9,10 +17,6 @@ Drop into a random Linux box via `wsl`, SSH, a container, or a teammate's laptop `about` prints the orientation facts first, then a short cheat sheet of the commands that actually help on *this* OS family. -Under https://www.nushell.sh/[Nushell], the cheat sheet switches to structured `nu` idioms (`sys`, `$env`, `ls`, …). -Outside Nushell, you still get the full classic tip sheet — plus a nudge to install `nu`. -Nushell is never required; `about` always runs. - == Quick start [source,shell] diff --git a/docs/modules/ROOT/pages/nushell.adoc b/docs/modules/about/pages/nushell.adoc similarity index 100% rename from docs/modules/ROOT/pages/nushell.adoc rename to docs/modules/about/pages/nushell.adoc diff --git a/docs/modules/ROOT/pages/related.adoc b/docs/modules/about/pages/related.adoc similarity index 100% rename from docs/modules/ROOT/pages/related.adoc rename to docs/modules/about/pages/related.adoc diff --git a/docs/modules/ROOT/pages/usage.adoc b/docs/modules/about/pages/usage.adoc similarity index 100% rename from docs/modules/ROOT/pages/usage.adoc rename to docs/modules/about/pages/usage.adoc From 965fd6f84d7b9c8e9eb4450df031cedc86fb077d Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Tue, 29 Sep 2026 00:28:05 +0000 Subject: [PATCH 2/2] docs(about): same-component xrefs for tools siblings Use module-qualified xrefs (prohelp, info, nu-require) under tools; keep shell-architecture as cross-component. Co-authored-by: Ryan Johnson --- docs/modules/about/pages/related.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/modules/about/pages/related.adoc b/docs/modules/about/pages/related.adoc index 191e235..21c4f23 100644 --- a/docs/modules/about/pages/related.adoc +++ b/docs/modules/about/pages/related.adoc @@ -1,9 +1,9 @@ = Related Tools :description: OpenShellOrg tools that pair with about. -* xref:prohelp::index.adoc[prohelp] — progressive help + global `help` -* xref:info::index.adoc[info] — Info TUI (OpenShellOrg) -* xref:nu-require::index.adoc[nu-require] — require / relaunch under Nushell +* xref:prohelp:index.adoc[prohelp] — progressive help + global `help` +* xref:info:index.adoc[info] — Info TUI (OpenShellOrg) +* xref:nu-require:index.adoc[nu-require] — require / relaunch under Nushell * xref:shell-architecture::index.adoc[shell-architecture] — OpenShellOrg thesis * xref:shell-architecture::entrypoint-dispatch.adoc[Entrypoint Dispatch] — auto-install + re-exec at the shell boundary * https://justine.lol/cosmopolitan/[Cosmopolitan Libc] — build-once run-anywhere C