docs(antora): register about under shared tools component - #1
Merged
Merged
Conversation
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 <AMDphreak@users.noreply.github.com>
Use module-qualified xrefs (prohelp, info, nu-require) under tools; keep shell-architecture as cross-component. Co-authored-by: Ryan Johnson <AMDphreak@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
tools(shared OpenShellOrg Tools component) with moduleabout(wasROOT/ standaloneaboutcomponent).about(the CLI name), not "Overview".index.adoclede so a cold reader immediately sees machine-orientation CLI (OS, shell, environment + cheat sheet), not an org "About" page.prohelp,info, andnu-requireuse same-component module xrefs (xref:prohelp:index.adoc, etc.);shell-architecturestays cross-component.Hub dependency
The openshellorg/docs (or site) playbook must already list (or be updated to list) this content source with
name: toolsand expect theaboutmodule — coordinate merge with hub Tools wiring if the playbook still keys onname: aboutorROOT.Changelog
CHANGELOG.adoc— Antora migration entry (2026-09-29).