Skip to content
This repository was archived by the owner on May 14, 2025. It is now read-only.

Commit d3b1530

Browse files
committed
Basic docs structure overhaul
1 parent bc695ad commit d3b1530

22 files changed

+56
-28
lines changed

docs/modules/ROOT/nav.adoc

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,25 @@
11
* xref:index.adoc[Overview]
22
* xref:installation.adoc[Installation]
33
* xref:getting-started.adoc[Getting Started]
4-
* xref:creating-new-projects.adoc[Creating New Projects]
5-
* xref:registering-new-projects.adoc[Registering Projects]
6-
* xref:adding-to-existing-projects.adoc[Adding to Existing Projects]
7-
* xref:boot-add-guide.adoc[Using "boot add"]
8-
* xref:ai-guide.adoc[Guide to "ai Commands"]
9-
* xref:user-command-guide.adoc[User defined Commands]
10-
* xref:action-file-overview.adoc[Overview of Action Files]
11-
* xref:action-guide.adoc[Guide to Action Files]
12-
* xref:roles-guide.adoc[Guide to Roles]
13-
* xref:special-commands-guide.adoc[Guide to Special Commands]
14-
* xref:initializr.adoc[Guide to Initializr Commands]
15-
* xref:readme-command-guide.adoc[Guide to README Commands]
164
* xref:key-concepts.adoc[Key Concepts]
17-
* xref:comments-on-the-approach.adoc[Comments on the Approach]
5+
* xref:ref/index.adoc[]
6+
** xref:ref/project/index.adoc[]
7+
*** xref:ref/project/creating-new-projects.adoc[Creating New Projects]
8+
*** xref:ref/project/comments-on-the-approach.adoc[Comments on the Approach]
9+
*** xref:ref/project/adding-to-existing-projects.adoc[Adding to Existing Projects]
10+
** xref:ref/catalog/index.adoc[]
11+
*** xref:ref/catalog/registering-new-projects.adoc[]
12+
** xref:ref/actionfile/index.adoc[]
13+
*** xref:ref/actionfile/action-guide.adoc[Guide to Action Files]
14+
*** xref:ref/actionfile/roles-guide.adoc[Guide to Roles]
15+
** xref:ref/usercommand/index.adoc[]
16+
*** xref:ref/usercommand/user-command-guide.adoc[User defined Commands]
17+
*** xref:ref/usercommand/action-file-overview.adoc[Overview of Action Files]
18+
** xref:ref/ai/index.adoc[]
19+
*** xref:ref/ai/readme-command-guide.adoc[Guide to README Commands]
20+
* xref:howto/index.adoc[]
21+
** xref:howto/boot-add-guide.adoc[Using "boot add"]
22+
** xref:howto/ai-guide.adoc[Guide to "ai Commands"]
23+
** xref:howto/special-commands-guide.adoc[Guide to Special Commands]
24+
** xref:howto/initializr.adoc[Guide to Initializr Commands]
1825
* xref:glossary.adoc[Glossary]

docs/modules/ROOT/pages/getting-started.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Created project in directory 'my-app'
1515
----
1616

1717
NOTE: If the CLI seems to be stuck at the cloning step, you might be hitting GitHub rate limiting. Use the `spring github auth login` command to authenticate.
18-
18+
1919
You can now `cd` into the `my-app` directory and build and run the application, which is, by default, a simple web application with a single endpoint:
2020

2121
[source, bash]
@@ -42,6 +42,6 @@ The README.adoc file in the new project contains more information on how the web
4242

4343
== Next steps
4444

45-
The xref:creating-new-projects.adoc[Creating New Projects] section shows you how to create applications other than the default application.
45+
The xref:ref/project/creating-new-projects.adoc[Creating New Projects] section shows you how to create applications other than the default application.
4646

47-
The xref:adding-to-existing-projects.adoc[Adding To Existing Projects] section shows you how to add additional applications into your current working project.
47+
The xref:ref/project/adding-to-existing-projects.adoc[Adding To Existing Projects] section shows you how to add additional applications into your current working project.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
= How-to Guides
2+
3+
This section provides answers to some common ‘how do I do that…​’ questions that often arise when using Spring CLI. Its coverage is not exhaustive, but it does cover quite a lot.

docs/modules/ROOT/pages/action-guide.adoc renamed to docs/modules/ROOT/pages/ref/actionfile/action-guide.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ actions:
3131
The `{{user-name}}` and `{{os-name}}` variables are replaced with actual values by the Handlebars template engine.
3232
Command line options passed to user-defined command are exposed as variables to be used by the template engine.
3333

34-
For more information on predefined template engine variables, see the xref:user-command-guide.adoc#_template_engine[Template Engine] section.
34+
For more information on predefined template engine variables, see the xref:ref/usercommand/user-command-guide.adoc#_template_engine[Template Engine] section.
3535

3636
=== Literal Syntax
3737

@@ -96,7 +96,7 @@ The following listing shows its contents:
9696
}
9797
```
9898

99-
Running `spring hello create` from the xref:action-file-overview.adoc#_an_introductory_example[introductory example] produces a file called `hello.json`, as follows:
99+
Running `spring hello create` from the xref:ref/usercommand/action-file-overview.adoc#_an_introductory_example[introductory example] produces a file called `hello.json`, as follows:
100100

101101
```
102102
$ spring hello create
@@ -133,7 +133,7 @@ actions:
133133
from: RestController.java
134134
```
135135

136-
For more information on predefined template engine variables, see the xref:user-command-guide.adoc#_template_engine[Template Engine] section.
136+
For more information on predefined template engine variables, see the xref:ref/usercommand/user-command-guide.adoc#_template_engine[Template Engine] section.
137137

138138
[[action-inject]]
139139
== Inject
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
= Action Files
2+
3+
These define the actions that can be taken on a project.

0 commit comments

Comments
 (0)