Initial antora docs structure

This commit is contained in:
Janne Valkealahti
2023-08-16 07:42:19 +01:00
parent d4b9d071ba
commit 05a0520596
13 changed files with 109 additions and 0 deletions

5
.gitignore vendored
View File

@@ -25,3 +25,8 @@ out
/.gradletasknamecache
**/*.flattened-pom.xml
node
node_modules
package-lock.json
package.json

View File

@@ -69,6 +69,7 @@
<jtokkit.version>0.6.1</jtokkit.version>
<!-- documentation dependencies -->
<io.spring.maven.antora-version>0.0.4</io.spring.maven.antora-version>
<asciidoctorj-pdf.version>1.6.2</asciidoctorj-pdf.version> <!-- FIXME build failure with version 2.3.9 -->
<asciidoctorj-epub.version>1.5.1</asciidoctorj-epub.version>
<spring-asciidoctor-backends.version>0.0.6</spring-asciidoctor-backends.version>

View File

@@ -12,6 +12,27 @@
<build>
<plugins>
<plugin>
<groupId>io.spring.maven.antora</groupId>
<artifactId>antora-maven-plugin</artifactId>
<version>${io.spring.maven.antora-version}</version>
<extensions>true</extensions>
<configuration>
<playbook>src/main/antora/antora-playbook.yml</playbook>
</configuration>
</plugin>
<plugin>
<groupId>io.spring.maven.antora</groupId>
<artifactId>antora-component-version-maven-plugin</artifactId>
<version>${io.spring.maven.antora-version}</version>
<executions>
<execution>
<goals>
<goal>antora-component-version</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>

View File

@@ -0,0 +1,37 @@
# PACKAGES antora@3.2.0-alpha.2 @antora/atlas-extension:1.0.0-alpha.1 @antora/collector-extension@1.0.0-alpha.3 @springio/antora-extensions@1.1.0-alpha.2 @asciidoctor/tabs@1.0.0-alpha.12 @opendevise/antora-release-line-extension@1.0.0-alpha.2
#
# The purpose of this Antora playbook is to build the docs in the current branch.
antora:
extensions:
- '@antora/collector-extension'
- require: '@springio/antora-extensions/root-component-extension'
root_component_name: 'ai'
site:
title: Spring AI Reference
url: https://docs.spring.io/spring-ai/reference
content:
sources:
- url: ./../../../..
branches: HEAD
start_path: spring-ai-docs/src/main/antora
worktrees: true
asciidoc:
attributes:
page-pagination: ''
hide-uri-scheme: '@'
tabs-sync-option: '@'
chomp: 'all'
extensions:
- '@asciidoctor/tabs'
- '@springio/asciidoctor-extensions'
sourcemap: true
urls:
latest_version_segment: ''
runtime:
log:
failure_level: warn
format: pretty
ui:
bundle:
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.0/ui-bundle.zip
snapshot: true

View File

@@ -0,0 +1,12 @@
name: ai
version: true
title: Spring AI
nav:
- modules/ROOT/nav.adoc
ext:
collector:
- run:
command: mvnw process-resources
local: true
scan:
dir: target/classes/antora-resources

View File

@@ -0,0 +1,8 @@
* xref:index.adoc[Overview]
* xref:domain/index.adoc[]
** xref:domain/prompt.adoc[]
* xref:prompt/index.adoc[]
* xref:client/index.adoc[]
** xref:client/usage.adoc[]
* Appendices
** xref:glossary.adoc[]

View File

@@ -0,0 +1,3 @@
= Configuring an AiClient
TBD

View File

@@ -0,0 +1,3 @@
= Using AiClient
TBD

View File

@@ -0,0 +1,3 @@
= The Domain Language of AI
TBD

View File

@@ -0,0 +1,7 @@
= Prompt
TBD
== AiClient
TBD

View File

@@ -0,0 +1,3 @@
[appendix]
[glossary]
= Glossary

View File

@@ -0,0 +1,3 @@
= Spring AI
Reference Documentation

View File

@@ -0,0 +1,3 @@
= Creating a Prompt
TBD