Skip to content

Commit d74ede4

Browse files
committed
Update documentation
1 parent 0dafbc5 commit d74ede4

Some content is hidden

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

61 files changed

+666
-2035
lines changed

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
<module>spring-shell-test</module>
9494
<module>spring-shell-autoconfigure</module>
9595
<module>spring-shell-test-autoconfigure</module>
96-
<!-- <module>spring-shell-docs</module>-->
96+
<module>spring-shell-docs</module>
9797
<module>spring-shell-dependencies</module>
9898
<module>spring-shell-samples</module>
9999
<module>spring-shell-starters</module>

spring-shell-docs/modules/ROOT/nav.adoc

Lines changed: 4 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -8,40 +8,16 @@
88
** xref:commands/registration/programmatic.adoc[]
99
** xref:commands/registration/annotation.adoc[]
1010
** xref:commands/organize.adoc[]
11-
** xref:commands/availability.adoc[]
12-
** xref:commands/exceptionhandling/index.adoc[]
13-
*** xref:commands/exceptionhandling/resolving.adoc[]
14-
*** xref:commands/exceptionhandling/mappings.adoc[]
15-
*** xref:commands/exceptionhandling/annotation.adoc[]
16-
** xref:commands/alias.adoc[]
17-
** xref:commands/hidden.adoc[]
18-
** xref:commands/helpoptions.adoc[]
19-
** xref:commands/interactionmode.adoc[]
11+
** xref:commands/syntax.adoc[]
12+
** xref:commands/context.adoc[]
13+
** xref:commands/registry.adoc[]
14+
** xref:commands/help.adoc[]
2015
** xref:commands/builtin/index.adoc[]
2116
*** xref:commands/builtin/help.adoc[]
2217
*** xref:commands/builtin/clear.adoc[]
2318
*** xref:commands/builtin/exit.adoc[]
24-
*** xref:commands/builtin/stacktrace.adoc[]
25-
*** xref:commands/builtin/script.adoc[]
26-
*** xref:commands/builtin/history.adoc[]
27-
*** xref:commands/builtin/completion.adoc[]
2819
*** xref:commands/builtin/version.adoc[]
2920
** xref:commands/writing.adoc[]
30-
* xref:options/index.adoc[]
31-
** xref:options/basics/index.adoc[]
32-
*** xref:options/basics/programmatic.adoc[]
33-
*** xref:options/basics/annotation.adoc[]
34-
*** xref:options/basics/legacyannotation.adoc[]
35-
** xref:options/short.adoc[]
36-
** xref:options/arity.adoc[]
37-
** xref:options/positional.adoc[]
38-
** xref:options/optional.adoc[]
39-
** xref:options/default.adoc[]
40-
** xref:options/validation.adoc[]
41-
** xref:options/label.adoc[]
42-
** xref:options/types.adoc[]
43-
** xref:options/naming.adoc[]
44-
* xref:completion.adoc[]
4521
* xref:building.adoc[]
4622
* xref:components/index.adoc[]
4723
** xref:components/flow/index.adoc[]
@@ -76,25 +52,15 @@
7652
* xref:customization/index.adoc[]
7753
** xref:customization/styling.adoc[]
7854
** xref:customization/logging.adoc[]
79-
** xref:customization/commandnotfound.adoc[]
80-
** xref:customization/singlecommand.adoc[]
8155
** xref:customization/contextclose.adoc[]
8256
* xref:execution.adoc[]
83-
* xref:testing/index.adoc[]
84-
** xref:testing/basics.adoc[]
85-
** xref:testing/settings.adoc[]
8657
* Appendices
8758
** xref:appendices/techintro/index.adoc[]
88-
*** xref:appendices/techintro/registration.adoc[]
8959
*** xref:appendices/techintro/parser.adoc[]
9060
*** xref:appendices/techintro/execution.adoc[]
91-
*** xref:appendices/techintro/shellcontext.adoc[]
92-
*** xref:appendices/techintro/commandcontext.adoc[]
93-
*** xref:appendices/techintro/commandcatalog.adoc[]
9461
*** xref:appendices/techintro/theming.adoc[]
9562
*** xref:appendices/techintro/searchalgorithm.adoc[]
9663
** xref:appendices/debugging/index.adoc[]
9764
** xref:appendices/tui/index.adoc[]
9865
*** xref:appendices/tui/viewdev.adoc[]
99-
*** xref:appendices/tui/catalog.adoc[]
10066
* xref:api:attachment$index.html[Javadoc,role=link-external,window=_blank].

spring-shell-docs/modules/ROOT/pages/appendices/techintro/commandcontext.adoc

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

spring-shell-docs/modules/ROOT/pages/appendices/techintro/commandregistry.adoc

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

spring-shell-docs/modules/ROOT/pages/appendices/techintro/registration.adoc

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

spring-shell-docs/modules/ROOT/pages/appendices/techintro/shellcontext.adoc

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

spring-shell-docs/modules/ROOT/pages/appendices/tui/catalog.adoc

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

spring-shell-docs/modules/ROOT/pages/basics/index.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ we need to go through some of the fundamental concepts of Spring Shell.
77

88
Essentially, a few things needs to happen before you have a working Spring Shell application:
99

10-
- Create a Spring Boot application.
10+
- Create a Spring (Boot) application.
1111
- Define commands and options.
1212
- Package the application.
1313
- Run the application, either interactively or non-interactively.
1414

15-
You can get a full working Spring Shell application without defining any user-level commands
16-
as some basic built-in commands (such as `help` and `history`) are provided.
15+
You can get a fully working Spring Shell application without defining any user-level commands
16+
as some basic built-in commands (such as `help` and `clear`) are provided.
1717

spring-shell-docs/modules/ROOT/pages/basics/reading.adoc

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,8 @@
55
Throughout this documentation, we make references to configuring something by using
66
annotations or programmatic examples.
77

8-
NOTE: There are two annotation models: the xref:commands/registration/annotation.adoc[annotations] model
9-
referred to as the new annotation model, and the xref:commands/registration/legacyannotation.adoc[legacy annotations]
10-
model referred to as the old legacy annotation model.
8+
The annotation model relates to the use of `@Command`.
119

12-
The old legacy annotation model mostly relates to the use of `@ShellMethod` and `@ShellOption` and
13-
the new annotation model relates to the use of `@Command`.
10+
The programmatic model relates to creating commands using APIs such as `Command.Builder`.
1411

15-
The programmatic model is how things are actually registered, even if you use annotations.
16-
17-
NOTE: The documentation structure is getting revised to clarify how to provide configurations in separate ways.
12+
These approaches can be mixed in the same application.

0 commit comments

Comments
 (0)