Skip to content

Commit 3aaee89

Browse files
author
Jimisola Laursen
committed
docs: streamline nav and page structure
- Separate nav items instead of single monolithic page - Merge description.adoc content into index.adoc - Add license section to index.adoc - Change nav label from All to Overview Signed-off-by: jimisola <jimisola@jimisola.com>
1 parent 3a2c5d6 commit 3aaee89

3 files changed

Lines changed: 5 additions & 12 deletions

File tree

‎docs/modules/ROOT/nav.adoc‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
* xref:index.adoc[All]
2-
* xref:description.adoc[Description]
1+
* xref:index.adoc[Overview]
32
* xref:installation.adoc[Installation]
43
* xref:usage.adoc[Usage]
54
* xref:debugging.adoc[Debugging]

‎docs/modules/ROOT/pages/description.adoc‎

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

‎docs/modules/ROOT/pages/index.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
= Reqstool Java Annotations
22

3-
include::description.adoc[]
3+
This provides Java annotations and processing of annotated code.
44

5-
include::installation.adoc[]
5+
Enables the usage of `@Requirements` and `@SVCs` annotations and processors to collect, format and write annotations data to yaml files.
66

7-
include::usage.adoc[]
7+
== License
88

9-
include::debugging.adoc[]
9+
MIT License.

0 commit comments

Comments
 (0)