Skip to content

Commit 178be2d

Browse files
adamsitnikjeffhandleygewarrenjonsequitur
authored
System.CommandLine docs update (#46594)
* Updating docs to beta5: symbols, syntax, getting started guide * Updating docs to beta5: termination, middleware, completions, binding * Updating docs to beta5: help customization * move "design guidance" to a dedicated doc, introduce new paragraphs: symbols and naming * join syntax and "define commands", simplify the descriptions and just briefly mention features that are not expected to be used frequently like Recursive or Hidden symbols * improve getting started tutorial: start it with bare minimum sample that does not use invocation at all, then use help to explain what invocation is and what it provides * update Help customization based on our recent changes * the separation of parsing and invocation * simplify parsing and validation doc, add config doc, polish other docs * beta5 migration guide --------- Co-authored-by: Jeff Handley <[email protected]> Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Jon Sequeira <[email protected]>
1 parent ee28614 commit 178be2d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+1915
-2038
lines changed

.openpublishing.redirection.fundamentals.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,34 @@
168168
"source_path_from_root": "/docs/fundamentals/networking/httpclient.md",
169169
"redirect_url": "/dotnet/fundamentals/networking/http/httpclient"
170170
},
171+
{
172+
"source_path_from_root": "/docs/standard/commandline/customize-help.md",
173+
"redirect_url": "/dotnet/standard/commandline/how-to-customize-help"
174+
},
175+
{
176+
"source_path_from_root": "/docs/standard/commandline/define-commands.md",
177+
"redirect_url": "/dotnet/standard/commandline/syntax#commands"
178+
},
179+
{
180+
"source_path_from_root": "/docs/standard/commandline/dependency-injection.md",
181+
"redirect_url": "/dotnet/standard/commandline/migration-guide-2.0.0-beta5#invocation"
182+
},
183+
{
184+
"source_path_from_root": "/docs/standard/commandline/handle-termination.md",
185+
"redirect_url": "/dotnet/standard/commandline/how-to-parse-and-invoke#process-termination-timeout"
186+
},
187+
{
188+
"source_path_from_root": "/docs/standard/commandline/model-binding.md",
189+
"redirect_url": "/dotnet/standard/commandline/how-to-parse-and-invoke"
190+
},
191+
{
192+
"source_path_from_root": "/docs/standard/commandline/use-middleware.md",
193+
"redirect_url": "/dotnet/standard/commandline/migration-guide-2.0.0-beta5#configuration"
194+
},
195+
{
196+
"source_path_from_root": "/docs/standard/commandline/tab-completion.md",
197+
"redirect_url": "/dotnet/standard/commandline/how-to-enable-tab-completion"
198+
},
171199
{
172200
"source_path_from_root": "/docs/fundamentals/networking/httpclient-guidelines.md",
173201
"redirect_url": "/dotnet/fundamentals/networking/http/httpclient-guidelines"

docs/fundamentals/toc.yml

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -934,22 +934,25 @@ items:
934934
href: ../standard/commandline/index.md
935935
- name: Get started tutorial
936936
href: ../standard/commandline/get-started-tutorial.md
937-
- name: Command-line syntax
937+
- name: Command-line syntax overview
938938
href: ../standard/commandline/syntax.md
939-
- name: Define commands
940-
href: ../standard/commandline/define-commands.md
941-
- name: Model binding
942-
href: ../standard/commandline/model-binding.md
943-
- name: Tab completion
944-
href: ../standard/commandline/tab-completion.md
945-
- name: Dependency injection
946-
href: ../standard/commandline/dependency-injection.md
947-
- name: Customize help
948-
href: ../standard/commandline/customize-help.md
949-
- name: Handle termination
950-
href: ../standard/commandline/handle-termination.md
951-
- name: Use middleware
952-
href: ../standard/commandline/use-middleware.md
939+
- name: How to
940+
expanded: true
941+
items:
942+
- name: Parse and invoke the result
943+
href: ../standard/commandline/how-to-parse-and-invoke.md
944+
- name: Customize parsing and validation
945+
href: ../standard/commandline/how-to-customize-parsing-and-validation.md
946+
- name: Configure the parser
947+
href: ../standard/commandline/how-to-configure-the-parser.md
948+
- name: Enable and customize tab completion
949+
href: ../standard/commandline/how-to-enable-tab-completion.md
950+
- name: Customize help
951+
href: ../standard/commandline/how-to-customize-help.md
952+
- name: Design guidance
953+
href: ../standard/commandline/design-guidance.md
954+
- name: Migration guide to 2.0.0-beta5
955+
href: ../standard/commandline/migration-guide-2.0.0-beta5.md
953956
- name: File and stream I/O
954957
items:
955958
- name: Overview

docs/standard/commandline/customize-help.md

Lines changed: 0 additions & 140 deletions
This file was deleted.

0 commit comments

Comments
 (0)