Skip to content

docs: direct new users to correct starting point #539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/src/modules/ROOT/partials/new-to-akka-start-here.adoc
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It read somewhat strange, trying a new phrasing in 8192af4


====
2 changes: 2 additions & 0 deletions docs/src/modules/getting-started/pages/addview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/src/modules/getting-started/pages/ask-akka-agent.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
= AI RAG Agent Part 1: The agent
:page-aliases: java:ask-akka/session.adoc
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added some more redirects


include::ROOT:partial$include.adoc[]

include::ROOT:partial$new-to-akka-start-here.adoc[]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and some more "Start here"


== Overview

This guide starts with creating an agent. We will incorporate Retrieval-Augmented Generation (RAG) in the next steps.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/src/modules/getting-started/pages/endpoints.adoc
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
3 changes: 3 additions & 0 deletions docs/src/modules/getting-started/pages/indexer.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/src/modules/getting-started/pages/rag.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
7 changes: 1 addition & 6 deletions docs/src/modules/getting-started/pages/samples.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions docs/src/modules/java/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading