Update docs

This commit is contained in:
Janne Valkealahti
2023-10-07 08:09:51 +01:00
parent 2e95fccbd5
commit 9a5f189783
17 changed files with 30 additions and 24 deletions

View File

@@ -0,0 +1,17 @@
[[using-shell-basics]]
= Basics
:page-section-summary-toc: 1
This section covers the basics of Spring Shell. Before going on to define actual commands and options,
we need to go through some of the fundamental concepts of Spring Shell.
Essentially, a few things needs to happen before you have a working Spring Shell application:
- Create a Spring Boot application.
- Define commands and options.
- Package the application.
- Run the application, either interactively or non-interactively.
You can get a full working Spring Shell application without defining any user-level commands
as some basic built-in commands (such as `help` and `history`) are provided.

View File

@@ -0,0 +1,19 @@
[[using-shell-basics-reading]]
= Reading Docs
:page-section-summary-toc: 1
Throughout this documentation, we make references to configuring something by using
annotations or programmatic examples.
NOTE: There are two annotation models, xref:commands/registration/annotation.adoc[annotations]
referred to new annotation model, xref:commands/registration/legacyannotation.adoc[legacy annotations]
referred to old legacy annotation model.
Old legacy annotation model mostly relates to use of `@ShellMethod` and `@ShellOption` and
new annotation model relates to use of `@Command`.
The programmatic model is how things are actually registered, even if you use annotations.
NOTE: Currently whole documentation structure is in transit to provide better
structure how things can be used using different ways to provide configurations.
So pardon a for little confusion now and there during a transit.