docs: PR-C — rebrand CLI references + new shim shape (#198, #203)#205
Merged
Conversation
Closes #198 and completes PR-C of #203. ## Scope Two related sweeps in one PR: 1. **CLI/brand rebrand (closes #198)**: replace stale `nuke` CLI command examples with `fallout` across `docs/`, switch `.nuke` directory-marker references to `.fallout`, rebrand "NUKE provides/comes/has/integrates" phrasing to "Fallout …" where it describes the current product (not the historical project), update namespace examples (`Nuke.Common.Tools.*` → `Fallout.Common.Tools.*`, `Nuke.GlobalTool` → `Fallout.GlobalTool`), and update MSBuild property names (`NukeRootDirectory` → `FalloutRootDirectory`, with the legacy names called out as still-honoured). 2. **New shim shape (PR-C of #203)**: update CONTRIBUTING.md, CLAUDE.md, `docs/01-getting-started/02-setup.md`, `docs/01-getting-started/03-execution.md`, and `docs/05-cicd/github-actions.md` to describe the thin shims + local-tool-manifest pattern PR-B introduced: drop `build.cmd` from examples, document the new 3-step GitHub Actions shape (`actions/setup-dotnet` → `dotnet tool restore` → `dotnet fallout`), describe `.config/dotnet-tools.json`. ## What's NOT touched - `docs/rebrand-plan.md` — intentionally NUKE-named throughout (it's the rebrand plan). - `docs/migration/from-nuke.md` — migration framing needs both names. - The `Nuke.<X>` namespace mentions inside `docs/rebrand-plan.md`'s mapping tables and the bridge-package strategy section. - Historical references like "upstream NUKE issue #822" and "the original NUKE key was matkoch-owned" — these cite the upstream project and need to stay accurate. - `CHANGELOG.md`, `src/Fallout.Migrate.Analyzers/README.md`, and other package READMEs that reference the historical NUKE project for migration context. ## Files changed 22 docs + CONTRIBUTING.md + CLAUDE.md. Most edits are mechanical text substitutions; the substantive rewrites are: - `docs/01-getting-started/02-setup.md`: new file structure example (drops `build.cmd`, adds `.config/dotnet-tools.json` and `.fallout/`), new note explaining the thin-shim role, MSBuild property names updated. - `docs/01-getting-started/03-execution.md`: thin-shim explanation in the Global Tool / Windows / Linux tab block; all `nuke <target>` / `nuke --help` / `nuke --plan` / etc. switched to `fallout`. - `docs/05-cicd/github-actions.md`: generated-output YAML examples updated to the 3-step shape; cache-step `actions/cache@v2` bumped to `@v4` with the current key files; upload-artifact `@v1` bumped to `@v5` to match the actual generator output; new note explaining the `dotnet-tools.json` requirement. - `docs/06-global-tool/00-shell-completion.md`: shell completion scripts rebranded (command name + function names: `_nuke_zsh_complete` → `_fallout_zsh_complete`, etc.). - `docs/06-global-tool/03-navigation.md`: navigation function names rebranded (`nuke.` → `fallout.`, etc.). ## Verification - Edits don't change link targets, only prose and code examples. - Docusaurus `onBrokenLinks: 'throw'` will catch any regression at deploy time. PR-C is docs-only and hits the noop `ubuntu-latest-docs.yml` workflow so the GitHub PR check stays green. ## Refs - Closes #198 (docs CLI cleanup). - Completes PR-C of #203 (bootstrapper-deprecation plan). PR-A (#201) and PR-B (#204) are already merged. - Companion issue #199 (CLI alias bridge guide for migrating users) is a separate enhancement, not in scope here. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.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
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.
Closes #198 and completes PR-C of #203.
Scope
Two related sweeps bundled into one PR:
nukereferences withfalloutacross docs/ #198) — replace stalenukeCLI command examples withfalloutacrossdocs/, switch.nukedirectory-marker references to.fallout, rebrand "NUKE provides/comes/has/integrates" phrasing to "Fallout …" where it describes the current product, update namespace examples (Nuke.Common.Tools.*→Fallout.Common.Tools.*,Nuke.GlobalTool→Fallout.GlobalTool), and update MSBuild property names (NukeRootDirectory→FalloutRootDirectory, with the legacy names called out as still-honoured).CONTRIBUTING.md,CLAUDE.md,docs/01-getting-started/{02-setup,03-execution}.md, anddocs/05-cicd/github-actions.mdto describe the thin shims + local-tool-manifest pattern PR-B introduced: dropbuild.cmdfrom examples, document the new 3-step GitHub Actions shape, describe.config/dotnet-tools.json.What's NOT touched
docs/rebrand-plan.md— intentionally NUKE-named throughout (it IS the rebrand plan).docs/migration/from-nuke.md— migration framing needs both names.CHANGELOG.mdand package READMEs that reference the historical NUKE project for migration context.Files changed
22 docs +
CONTRIBUTING.md+CLAUDE.md(23 files total).Most edits are mechanical text substitutions. Substantive rewrites:
docs/01-getting-started/02-setup.md— new file-structure example (dropsbuild.cmd, adds.config/dotnet-tools.jsonand.fallout/), new note explaining the thin-shim role, MSBuild property names updated.docs/01-getting-started/03-execution.md— thin-shim explanation in the Global Tool / Windows / Linux tab block; allnuke <target>/nuke --help/nuke --plan/ etc. switched tofallout.docs/05-cicd/github-actions.md— generated-output YAML examples updated to the 3-step shape; cache-stepactions/cache@v2bumped to@v4with the current key files;actions/upload-artifact@v1bumped to@v5to match the actual generator output; new note explaining thedotnet-tools.jsonrequirement.docs/06-global-tool/00-shell-completion.md— shell completion scripts rebranded (command name + function names:_nuke_zsh_complete→_fallout_zsh_complete, etc.).docs/06-global-tool/03-navigation.md— navigation function names rebranded (nuke.→fallout., etc.).Verification
onBrokenLinks: 'throw'will catch any regression at deploy time.ubuntu-latest-docs.ymlworkflow handles the GitHub PR check.Test plan
ubuntu-latest(docs-only noop) goes green.Build Setup,Build Execution,GitHub Actions,Shell Completion.Refs
nukereferences withfalloutacross docs/ #198 (docs CLI cleanup).nuke→falloutCLI per OS/shell #199 (CLI alias bridge guide for migrating users) is a separate enhancement, not in scope here.