You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/coffee-agntcy/get-started.md
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -99,5 +99,4 @@ graph LR
99
99
GC <--> TF[Tatooine Farm Agent]
100
100
```
101
101
102
-
103
102
Learn more on how to deploy Lungo locally by visiting the [Lungo Deployment Guide](https://github.com/agntcy/coffeeAgntcy/blob/main/coffeeAGNTCY/coffee_agents/lungo/README.md)
Copy file name to clipboardExpand all lines: docs/coffee-agntcy/slim-coffee-agntcy.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,22 +23,22 @@ transport = factory.create_transport("SLIM", endpoint=SLIM_ENDPOINT, name="defau
23
23
24
24
Where:
25
25
26
-
*`AgntcyFactory` initializes the factory for the agent.
27
-
*`create_transport("SLIM", ...)` provisions a SLIM transport instance connected to the configured endpoint.
26
+
-`AgntcyFactory` initializes the factory for the agent.
27
+
-`create_transport("SLIM", ...)` provisions a SLIM transport instance connected to the configured endpoint.
28
28
29
29
## Sending Messages
30
30
31
31
SLIM accommodates both targeted and broadcast messaging within the same API:
32
32
33
-
***1-to-1 Message**
33
+
-**1-to-1 Message**
34
34
35
35
Used when the supervisor agent needs to send a request to a single farm agent:
36
36
37
37
```python
38
38
response =await client.send_message(request)
39
39
```
40
40
41
-
***Publisher/Subscriber Pattern**
41
+
-**Publisher/Subscriber Pattern**
42
42
43
43
Used when the auction supervisor sends the same request to multiple farm agents and waits forall the responses:
44
44
@@ -52,10 +52,10 @@ SLIM accommodates both targeted and broadcast messaging within the same API:
52
52
53
53
Where:
54
54
55
-
*`broadcast_topic`is the topic to which the message is broadcasted.
56
-
*`recipients`is the list of agents to which the message is sent.
55
+
-`broadcast_topic`is the topic to which the message is broadcasted.
56
+
-`recipients`is the list of agents to which the message is sent.
57
57
58
-
### Streaming Publisher/Subscriber
58
+
### Streaming Publisher/Subscriber
59
59
60
60
For real-time responses as farms reply, use the streaming variant:
61
61
@@ -69,7 +69,7 @@ SLIM accommodates both targeted and broadcast messaging within the same API:
69
69
70
70
This returns a stream of data from the farms.
71
71
72
-
***Group Communication Pattern**
72
+
-**Group Communication Pattern**
73
73
74
74
Used when multiple agents participate in a group chat session, where all agents can send messages and listen to communications from other agents in the group:
75
75
@@ -85,13 +85,13 @@ SLIM accommodates both targeted and broadcast messaging within the same API:
85
85
86
86
Where:
87
87
88
-
*`init_message`is the initial message to start the group chat.
89
-
*`group_channel`is the unique channel IDfor the group chat session.
90
-
*`participants`is the list of agent topics participating in the group chat.
91
-
*`end_message`is the message that signals the end of the group chat.
92
-
*`timeout`is the timeout for the group chat session in seconds.
88
+
-`init_message`is the initial message to start the group chat.
89
+
-`group_channel`is the unique channel IDfor the group chat session.
90
+
-`participants`is the list of agent topics participating in the group chat.
91
+
-`end_message`is the message that signals the end of the group chat.
92
+
-`timeout`is the timeout for the group chat session in seconds.
93
93
94
-
### Streaming Group Communication
94
+
### Streaming Group Communication
95
95
96
96
For real-time order state transitions as each agent processes the order:
When creating a new issue, please be use the **New Issue** template, and provide as much relevant information as
12
-
possible.
11
+
When creating a new issue, use the **New Issue** template and provide as much relevant information as possible.
13
12
14
13
## Sending Pull Requests
15
14
@@ -27,7 +26,7 @@ If you move or rename a documentation file, **you must add a redirect** to prese
27
26
28
27
To add a redirect:
29
28
30
-
1. Open `mkdocs/mkdocs.yml`
29
+
1. Open `mkdocs/mkdocs.yml`.
31
30
1. Add an entry to the `redirect_maps` under the `redirects` plugin:
32
31
33
32
```yaml
@@ -37,32 +36,48 @@ To add a redirect:
37
36
'old/path/to/file.md': 'new/path/to/file.md'
38
37
```
39
38
40
-
1. Test the redirect locally by running `task build` or `task run` and verifying the old URL redirects to the new location
39
+
1. Test the redirect locally by running `task build` or `task run` and verifying the old URL redirects to the new location.
41
40
42
41
!!! warning
43
42
44
43
Failing to add redirects will result in broken links and a poor user experience. Always add redirects when moving content.
45
44
45
+
## Linting and Running the Documentation Site Locally
46
+
47
+
The documentation site is built using [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). It also uses [Lychee](https://github.com/lycheeverse/lychee) to check for broken links and Taskfile to run the documentation site locally and lint the documentation.
48
+
49
+
To run the documentation site locally and lint the documentation, you need the following prerequisites:
- [Python version 3.13 or higher](https://www.python.org/)
54
+
- [Lychee](https://github.com/lycheeverse/lychee)
55
+
56
+
To run the documentation site locally, use `task run`. This will start a live-reloading server at `http://localhost:8000`, allowing you to view the documentation site in your browser in real time.
57
+
58
+
To lint and check for errors in the documentation, use `task lint`. This checks for broken links, spelling errors, and markdown syntax errors.
Don't add hard line breaks at a certain line-length, enable line-wrapping in your editor instead. Otherwise searching for sentences in the code becomes a pain.
67
+
Do not add hard line breaks at a certain line-length, enable line-wrapping in your editor instead. Otherwise searching for sentences in the code becomes a pain.
53
68
54
69
### Headings
55
70
56
71
- Start with level 1 heading (#).
57
72
- Use hashmarks for headings.
58
-
- Use title case (`# Start Every Word with Uppercase Except for Articles and Coordinating Conjunctions`)
59
-
- Keep titles reasonably short (they show up in the right-hand toc)
73
+
- Use title case (`# Start Every Word with Uppercase Except for Articles and Coordinating Conjunctions`).
74
+
- Keep titles reasonably short (they show up in the right-hand toc).
60
75
- Do not skip heading levels.
61
76
62
77
### Lists
63
78
64
-
- Use dash (`-`) for bulleted lists
65
-
- Use only `1.` for ordered lists, they are automatically numbered in the output
79
+
- Use dash (`-`) for bulleted lists.
80
+
- Use only `1.` for ordered lists, they are automatically numbered in the output.
66
81
- Indent additional stuff that belongs to a list element by 4 spaces, for example:
67
82
68
83
```md
@@ -81,9 +96,14 @@ Don't add hard line breaks at a certain line-length, enable line-wrapping in you
81
96
82
97
### Links
83
98
84
-
- When linking to an external URL, or to a static HTML file within the project, use normal markdown linking `[text](url)`
99
+
- When linking to an external URL, or to a static HTML file within the project, use normal markdown linking `[text](url)`.
85
100
- When linking to a file within the docs, use `[link text](/docs/path/to/file.md)`.
86
-
- Use project-absolute paths in the links/refs: start with a /, then the path relative to the `content` directory, for example: `/docs/getting-started/example.md` (easier to update when a file is moved, and easier to recognize where it is pointing).
101
+
- Use project-absolute paths in the links and references: start with a `/`, then the path relative to the `content` directory.
102
+
103
+
!!! example
104
+
`/docs/getting-started/example.md`(easier to update when a file is moved, and easier to recognize where it is pointing).
105
+
106
+
- Always check for broken links by running `task lint` before submitting a pull request.
87
107
88
108
### Images
89
109
@@ -134,4 +154,4 @@ Is displayed as:
134
154
135
155
This is a note.
136
156
137
-
For more information, see the [Material for MkDocs reference](https://squidfunk.github.io/mkdocs-material/reference/).
157
+
For more information on formatting, see the [Material for MkDocs reference](https://squidfunk.github.io/mkdocs-material/reference/).
0 commit comments