docs(cli): clarify AddBranch shared settings#3
Merged
phil-scott-78 merged 2 commits intospectreconsole:mainfrom Jan 6, 2026
Merged
Conversation
Contributor
Author
|
FYI the GitHub Actions check suite is currently in an "action required" state (fork workflow approval), so CI hasn't run yet. Could a maintainer approve and run the workflows for this PR? I ran |
Contributor
|
sorry for the delay getting to this, was out traveling for the holidays. Looks good, thanks for taking the time to improve the docs |
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.
Context: spectreconsole/spectre.console#661 asked for clearer
AddBranchguidance; CLI docs now live in this repo.Changes:
AddBranchgeneric vs non-generic overloads on the command hierarchies page.list): give them a dedicated settings type inheriting from the branch settings.RemoteListSettings : RemoteSettingsso shared options work consistently.Verification:
dotnet build Spectre.Docs.slnx -c Releasedotnet run --project Spectre.Docs.Cli.Examples/Spectre.Docs.Cli.Examples.csproj -c Release -- 'M:Spectre.Docs.Cli.Examples.DemoApps.CommandHierarchies.Demo.RunAsync(System.String[])' remote --verbose list