Skip to content

Commit 5e8cbbf

Browse files
authored
fix(docs): incorrect GitHub casing (#796)
1 parent 53ee088 commit 5e8cbbf

File tree

9 files changed

+23
-23
lines changed

9 files changed

+23
-23
lines changed

docs/src/modules/getting-started/pages/ask-akka-agent/the-agent.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ You already learned how to create an empty Akka project when you went through th
2828

2929
[NOTE]
3030
====
31-
This guide is written assuming you will follow it as a tutorial to walk through all of the components, building them on your own. If at any time you want to compare your solution with the official sample, check out the link:https://github.com/akka-samples/ask-akka-agent[Github Repository, window="new"].
31+
This guide is written assuming you will follow it as a tutorial to walk through all of the components, building them on your own. If at any time you want to compare your solution with the official sample, check out the link:https://github.com/akka-samples/ask-akka-agent[GitHub Repository, window="new"].
3232
====
3333

3434
== Add the Agent

docs/src/modules/getting-started/pages/author-your-first-service.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You can run this sample without an OpenAI API key, but it will be more fun if yo
3030
[#clone_sample]
3131
== Clone the sample project
3232

33-
. From a command line, clone the link:https://github.com/akka-samples/helloworld-agent[Github Repository, window="new"] in a convenient location:
33+
. From a command line, clone the link:https://github.com/akka-samples/helloworld-agent[GitHub Repository, window="new"] in a convenient location:
3434
+
3535
[source, command line]
3636
----

docs/src/modules/getting-started/pages/planner-agent/activity.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ You already learned how to create an empty Akka project when you went through th
2525

2626
[NOTE]
2727
====
28-
This guide is written assuming you will follow it as a tutorial to walk through all of the components, building them on your own. If at any time you want to compare your solution with the official sample, check out the link:https://github.com/akka-samples/multi-agent[Github Repository, window="new"].
28+
This guide is written assuming you will follow it as a tutorial to walk through all of the components, building them on your own. If at any time you want to compare your solution with the official sample, check out the link:https://github.com/akka-samples/multi-agent[GitHub Repository, window="new"].
2929
====
3030

3131
== Add the Agent

docs/src/modules/getting-started/pages/samples.adoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This sample models an outdoor activities planner. It demonstrates how to build a
3939
**Concepts**: _Agent_, _Workflow_, _Multi-agent_, _LLM_
4040
**Level**: _Intermediate_
4141
xref:getting-started:planner-agent/index.adoc[Step-by-step guide]
42-
link:https://github.com/akka-samples/multi-agent[Github Repository, window="new"]
42+
link:https://github.com/akka-samples/multi-agent[GitHub Repository, window="new"]
4343

4444
== Chat agent with RAG
4545

@@ -49,7 +49,7 @@ This sample illustrates how to use a batching workflow to create embeddings for
4949
**Concepts**: _Agent_, _RAG_, _Vector database_
5050
**Level**: _Intermediate_
5151
xref:getting-started:ask-akka-agent/index.adoc[Step-by-step guide]
52-
link:https://github.com/akka-samples/ask-akka-agent[Github Repository, window="new"]
52+
link:https://github.com/akka-samples/ask-akka-agent[GitHub Repository, window="new"]
5353

5454
== Travel planning agent
5555

@@ -58,54 +58,54 @@ This sample illustrates reliable interaction with an LLM using a workflow. Entit
5858
[%hardbreaks]
5959
**Concepts**: _Agent_, _Agent Memory_, _Workflow_, _Entity_
6060
**Level**: _Beginner_
61-
link:https://github.com/akka-samples/travel-agent[Github Repository, window="new"]
61+
link:https://github.com/akka-samples/travel-agent[GitHub Repository, window="new"]
6262

6363
== Medical discharge summary tagging
6464
This sample illustrate the use of LLMs and prompts to summarize activities. It assigns tags to the medical discharge summaries, while also enabling human verification and comparative analysis. Interactions are from a workflow with an agent using the OpenAI API with configurable model choice.
6565

6666
[%hardbreaks]
6767
**Concepts**: _Agent_, _Summarization_, _Workflow_, _Entity_, _OpenAI_, _Human in the loop_
6868
**Level**: _Intermediate_
69-
link:https://github.com/akka-samples/medical-tagging-agent[Github Repository, window="new"]
69+
link:https://github.com/akka-samples/medical-tagging-agent[GitHub Repository, window="new"]
7070

7171
== IoT sensor monitoring
7272
This sample is a temperature monitoring system that collects, aggregates, and analyzes temperature data from IoT sensors. The system uses AI to generate insights about temperature trends and anomalies across different locations. Collects and aggregates temperature data using Key Value Entities. OpenAI is used for anomaly and trend detection.
7373

7474
[%hardbreaks]
7575
**Concepts**: _Agent_, _IoT_, _Trend analysis_, _Anomaly detection_, _Entity_, _OpenAI_
7676
**Level**: _Intermediate_
77-
link:https://github.com/akka-samples/temperature-monitoring-agent[Github Repository, window="new"]
77+
link:https://github.com/akka-samples/temperature-monitoring-agent[GitHub Repository, window="new"]
7878

7979
== Release note summarizer
8080
This sample is designed to run every time there is a release from configured GitHub repositories. It interacts with Anthropic Claude from an agent and uses tools to retrieve detailed information from GitHub. Entities are used for storing release summaries. A timed action looks for new releases periodically and creates the summary using the LLM.
8181

8282
[%hardbreaks]
8383
**Concepts**: _Agent_, _Entity_, _Timed Action_, _Anthropic Claude_, _Tools_, _Summarization_
8484
**Level**: _Intermediate_
85-
link:https://github.com/akka-samples/changelog-agent[Github Repository, window="new"]
85+
link:https://github.com/akka-samples/changelog-agent[GitHub Repository, window="new"]
8686

8787
== Customer service chat workflow
8888
The real-estate customer service agent demonstrates how to combine Akka features with an LLM model. It illustrates an agentic workflow for customer service. It processes incoming real-estate inquiries, analyzes the content to extract details, provides follow-up when needed and saves the collected information for future reference.
8989

9090
[%hardbreaks]
9191
**Concepts**: _Agent_, _Workflow_, _Analysis_, _Detail extraction_, _Human in the loop_, _Agent Memory_
9292
**Level**: _Intermediate_
93-
link:https://github.com/akka-samples/real-estate-cs-agent[Github Repository, window="new"]
93+
link:https://github.com/akka-samples/real-estate-cs-agent[GitHub Repository, window="new"]
9494

9595
== Trip booking with tools
9696
This app represents a travel agency that searches for flights and accommodations. It's composed by an LLM (Anthropic) using Spring AI and AI tools to find flights, accommodations and sending mails.
9797

9898
[%hardbreaks]
9999
**Concepts**: _Agent_, _Tools_, _Anthropic_, _Spring AI_, _Workflow_
100-
link:https://github.com/akka-samples/trip-agent[Github Repository, window="new"]
100+
link:https://github.com/akka-samples/trip-agent[GitHub Repository, window="new"]
101101

102102
== Multi-source health sensor analysis
103103
This sample illustrates an AI agent that uses an LLM and multiple tools to analyze data from fitness trackers, medical records and other sensors. It integrates with Fitbit and MongoDB Atlas.
104104

105105
[%hardbreaks]
106106
**Concepts**: _Agent_, _Analysis_, _Integrations_, _Vector database_
107107
**Level**: _Intermediate_
108-
link:https://github.com/akka-samples/healthcare-agent[Github Repository, window="new"]
108+
link:https://github.com/akka-samples/healthcare-agent[GitHub Repository, window="new"]
109109

110110
== Shopping cart
111111
This sample illustrates the basics of building a shopping cart with entities, views, and other core Akka components. There is also a step-by-step guide that gradually adds features to a core cart.
@@ -114,44 +114,44 @@ This sample illustrates the basics of building a shopping cart with entities, vi
114114
**Concepts**: _Entity_, _Events_, _HTTP Endpoint_
115115
**Level**: _Beginner_
116116
xref:getting-started:shopping-cart/build-and-deploy-shopping-cart.adoc[Step-by-step guide]
117-
link:https://github.com/akka-samples/shopping-cart-quickstart[Github Repository, window="new"]
117+
link:https://github.com/akka-samples/shopping-cart-quickstart[GitHub Repository, window="new"]
118118

119119
== Customer data store
120120
This sample illustrates the use of entities and query capabilities with a view. It shows a simple set of traditional queries and the standard create, update, and delete mutations through events.
121121

122122
[%hardbreaks]
123123
**Concepts**: _Entity_, _View_, _HTTP Endpoint_
124124
**Level**: Intermediate
125-
link:https://github.com/akka-samples/event-sourced-customer-registry[Github Repository, window="new"]
125+
link:https://github.com/akka-samples/event-sourced-customer-registry[GitHub Repository, window="new"]
126126

127127
== Wallet transfer
128128
This example illustrates a funds transfer workflow between two wallets, where the workflow orchestrates the interaction with an external service to perform the transfer.
129129

130130
[%hardbreaks]
131131
**Concepts**: _Transactions_, _Workflow_
132132
**Level**: _Intermediate_
133-
link:https://github.com/akka-samples/transfer-workflow-orchestration[Github Repository, window="new"]
133+
link:https://github.com/akka-samples/transfer-workflow-orchestration[GitHub Repository, window="new"]
134134

135135
== Wallet transfer with failure compensation
136136
This example illustrates a funds transfer workflow between two wallets. It also illustrates how to set up workflow _compensation_ in order to self-heal work when one or more steps in the workflow fail.
137137

138138
[%hardbreaks]
139139
**Concepts**: _Transactions_, _Workflow_, _Entity_
140140
**Level**: _Intermediate_
141-
link:https://github.com/akka-samples/transfer-workflow-compensation[Github Repository, window="new"]
141+
link:https://github.com/akka-samples/transfer-workflow-compensation[GitHub Repository, window="new"]
142142

143143
== Choreographed user signup flow
144144
This example is a user registration service where the user's new signup flow implemented as a choreography saga.
145145

146146
[%hardbreaks]
147147
**Concepts**: _Choreography_, _Saga_, _Workflow_
148148
**Level**: _Advanced_
149-
link:https://github.com/akka-samples/choreography-saga-quickstart[Github Repository, window="new"]
149+
link:https://github.com/akka-samples/choreography-saga-quickstart[GitHub Repository, window="new"]
150150

151151
== Akka Chess
152152
This example represents a complete, resilient, automatically scalable, event-sourced chess game. We will be adding a guided tour that will include adding an agent to act as a non-player "brain" that plays chess in real time against human players.
153153

154154
[%hardbreaks]
155155
**Concepts**: _Embedded UI_, _Entity_, _Workflow_, _View_, _Timed Action_
156156
**Level**: _Advanced_
157-
link:https://github.com/akka-samples/akka-chess[Github Repository, window="new"]
157+
link:https://github.com/akka-samples/akka-chess[GitHub Repository, window="new"]

docs/src/modules/getting-started/pages/shopping-cart/addview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ include::ROOT:partial$cloud-dev-prerequisites.adoc[]
1717

1818
== Clone the sample
1919

20-
. Clone the full source code of the Shopping Cart (with View) sample from link:https://github.com/akka-samples/shopping-cart-with-view[Github].
20+
. Clone the full source code of the Shopping Cart (with View) sample from link:https://github.com/akka-samples/shopping-cart-with-view[GitHub].
2121

2222
== Re-evaluating the shopping cart structure
2323

docs/src/modules/getting-started/pages/shopping-cart/build-and-deploy-shopping-cart.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ include::ROOT:partial$cloud-dev-prerequisites.adoc[]
2525

2626
== Clone the sample
2727

28-
. Clone the full source code of the Shopping Cart sample from link:https://github.com/akka-samples/shopping-cart-quickstart[Github], or use the Akka CLI command below to download and unzip this quickstart project.
28+
. Clone the full source code of the Shopping Cart sample from link:https://github.com/akka-samples/shopping-cart-quickstart[GitHub], or use the Akka CLI command below to download and unzip this quickstart project.
2929
+
3030
[source,bash]
3131
----

docs/src/modules/java/pages/agents.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -665,7 +665,7 @@ When executing the plan and calling the agents we know the id of the agent to ca
665665
include::example$multi-agent/src/main/java/demo/multiagent/application/AgentTeamWorkflow.java[tag=dynamicCall]
666666
----
667667

668-
You find the full source code for this multi-agent sample in the link:https://github.com/akka-samples/multi-agent[akka-samples/multi-agent Github Repository].
668+
You find the full source code for this multi-agent sample in the link:https://github.com/akka-samples/multi-agent[akka-samples/multi-agent GitHub Repository].
669669

670670
== Testing the agent
671671

docs/src/modules/java/pages/ai-coding-assistant.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ it should answer with something like
119119
Even though the documentation includes comprehensive code snippets it can be good to include the full source code of one or a few samples. This makes it easier for the coding assistant to follow the same structure as the sample.
120120

121121
. Pick one or a few samples from xref:getting-started:samples.adoc[], which are relevant to what you are developing. If you are just getting started learning Akka you can pick the Shopping Cart sample.
122-
. Clone the sample Github repository. Pull latest if you have already cloned the repository before.
122+
. Clone the sample GitHub repository. Pull latest if you have already cloned the repository before.
123123
. Copy the source code to a folder `akka-context/` in your development project, e.g. `akka-context/travel-agent/src`.
124124
. Add `akka-context/` to your `.gitignore` file, if you use git.
125125

docs/src/modules/java/pages/event-sourced-entities.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The steps necessary to implement an Event Sourced Entity include:
3030
. Model the entity's state and its domain events.
3131
. Implementing behavior in command and event handlers.
3232

33-
The following sections walk through these steps using a shopping cart service as an example (working sample can be downloaded from link:https://github.com/akka-samples/shopping-cart-quickstart[Github]).
33+
The following sections walk through these steps using a shopping cart service as an example (working sample can be downloaded from link:https://github.com/akka-samples/shopping-cart-quickstart[GitHub]).
3434

3535
== Modeling the entity
3636

0 commit comments

Comments
 (0)