diff --git a/docs/src/modules/ROOT/partials/new-to-akka-start-here.adoc b/docs/src/modules/ROOT/partials/new-to-akka-start-here.adoc new file mode 100644 index 000000000..161aaff01 --- /dev/null +++ b/docs/src/modules/ROOT/partials/new-to-akka-start-here.adoc @@ -0,0 +1,7 @@ +[TIP] +==== +*New to Akka? Start here:* + +Use the xref:getting-started:author-your-first-service.adoc[] guide to get a simple agentic service running locally and interact with it. + +==== diff --git a/docs/src/modules/getting-started/pages/addview.adoc b/docs/src/modules/getting-started/pages/addview.adoc index 7f8c47bd5..bed20c39d 100644 --- a/docs/src/modules/getting-started/pages/addview.adoc +++ b/docs/src/modules/getting-started/pages/addview.adoc @@ -3,6 +3,8 @@ include::ROOT:partial$include.adoc[] +include::ROOT:partial$new-to-akka-start-here.adoc[] + This guide walks you through the design and implementation of an enhancement to the shopping cart service example, illustrating model refactoring, the use of Views, and user authentication. == Overview diff --git a/docs/src/modules/getting-started/pages/ask-akka-agent.adoc b/docs/src/modules/getting-started/pages/ask-akka-agent.adoc index fe412ea26..9d2ef15c5 100644 --- a/docs/src/modules/getting-started/pages/ask-akka-agent.adoc +++ b/docs/src/modules/getting-started/pages/ask-akka-agent.adoc @@ -1,7 +1,10 @@ = AI RAG Agent Part 1: The agent +:page-aliases: java:ask-akka/session.adoc include::ROOT:partial$include.adoc[] +include::ROOT:partial$new-to-akka-start-here.adoc[] + == Overview This guide starts with creating an agent. We will incorporate Retrieval-Augmented Generation (RAG) in the next steps. diff --git a/docs/src/modules/getting-started/pages/build-and-deploy-shopping-cart.adoc b/docs/src/modules/getting-started/pages/build-and-deploy-shopping-cart.adoc index 2543fb956..86f7707fe 100644 --- a/docs/src/modules/getting-started/pages/build-and-deploy-shopping-cart.adoc +++ b/docs/src/modules/getting-started/pages/build-and-deploy-shopping-cart.adoc @@ -3,6 +3,8 @@ include::ROOT:partial$include.adoc[] +include::ROOT:partial$new-to-akka-start-here.adoc[] + This guide walks you through the design and implementation of a shopping cart service, illustrating the use of some of Akka's components. == Overview diff --git a/docs/src/modules/getting-started/pages/endpoints.adoc b/docs/src/modules/getting-started/pages/endpoints.adoc index 9d39b444f..4faf8b911 100644 --- a/docs/src/modules/getting-started/pages/endpoints.adoc +++ b/docs/src/modules/getting-started/pages/endpoints.adoc @@ -1,7 +1,10 @@ = AI RAG agent part 4: Adding UI endpoints +:page-aliases: java:ask-akka/endpoints.adoc include::ROOT:partial$include.adoc[] +include::ROOT:partial$new-to-akka-start-here.adoc[] + == Overview In this step of the guide, you'll add some endpoints to provide a client-friendly API in front of all of the RAG components you've been building. You'll create an API for submitting your "Ask Akka" questions (prompts), and one that serves up a self-hosted, static asset web UI. diff --git a/docs/src/modules/getting-started/pages/indexer.adoc b/docs/src/modules/getting-started/pages/indexer.adoc index 784ad5e2e..f6f85f8f8 100644 --- a/docs/src/modules/getting-started/pages/indexer.adoc +++ b/docs/src/modules/getting-started/pages/indexer.adoc @@ -1,7 +1,10 @@ = AI RAG agent part 2: Knowledge indexing with a workflow +:page-aliases: java:ask-akka/indexer.adoc include::ROOT:partial$include.adoc[] +include::ROOT:partial$new-to-akka-start-here.adoc[] + == Overview The first step in building a RAG agent is _indexing_. Each time a user submits a query or prompt to the agent, the agent _retrieves_ relevant documents by performing a semantic search on a vector database. Before we can perform that search, we need to populate the vector database with all of the knowledge that we want to make available to the agent. diff --git a/docs/src/modules/getting-started/pages/rag.adoc b/docs/src/modules/getting-started/pages/rag.adoc index 2ed4619f2..bc2229e81 100644 --- a/docs/src/modules/getting-started/pages/rag.adoc +++ b/docs/src/modules/getting-started/pages/rag.adoc @@ -1,7 +1,10 @@ = AI RAG agent part 3: Executing RAG queries +:page-aliases: java:ask-akka/rag.adoc include::ROOT:partial$include.adoc[] +include::ROOT:partial$new-to-akka-start-here.adoc[] + == Overview In this step of the guide to building the _Ask Akka_ application, you'll be creating a class that wraps the OpenAI API and the MongoDB client API. It's this class that will provide the abstraction for the rest of the application to use when making RAG queries. You'll use Akka's `@Setup` to configure the dependency injection for this class. diff --git a/docs/src/modules/getting-started/pages/samples.adoc b/docs/src/modules/getting-started/pages/samples.adoc index f2e762dda..51ea869da 100644 --- a/docs/src/modules/getting-started/pages/samples.adoc +++ b/docs/src/modules/getting-started/pages/samples.adoc @@ -2,12 +2,7 @@ :page-aliases: java:samples.adoc include::ROOT:partial$include.adoc[] -[TIP] -==== -*New to Akka? Start here:* - -xref:getting-started:author-your-first-service.adoc[] to get a minimal "Hello World!" Akka agentic service and run it locally. -==== +include::ROOT:partial$new-to-akka-start-here.adoc[] Samples are available that demonstrate important patterns and abstractions. These can be cloned from their respective repositories. Please refer to the `README` file in each repository for setup and usage instructions. diff --git a/docs/src/modules/java/pages/index.adoc b/docs/src/modules/java/pages/index.adoc index 3dbcce885..fa52f0c7b 100644 --- a/docs/src/modules/java/pages/index.adoc +++ b/docs/src/modules/java/pages/index.adoc @@ -2,6 +2,8 @@ include::ROOT:partial$include.adoc[] +include::ROOT:partial$new-to-akka-start-here.adoc[] + The Akka SDK provides you proven design patterns that enable your apps to remain responsive to change. It frees you from infrastructure concerns and lets you focus on the application logic. With its few, concise components, the Akka SDK is easy to learn, and you can develop services in quick, iterative steps by running your code locally with full insight through Akka's console.