Skip to content

Commit dd097f8

Browse files
committed
fix: lint more READMEs
1 parent 5b953ab commit dd097f8

File tree

8 files changed

+183
-135
lines changed

8 files changed

+183
-135
lines changed

.markdownlint.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@
33
# MD001: Heading levels should only increment by one level at a time
44
MD001: false
55

6+
# MD004: Unordered list style - allow different styles in sublists
7+
MD004:
8+
style: sublist
9+
610
# MD013: Line length
711
MD013:
812
line_length: 120
913
code_blocks: false
1014
tables: false
1115

12-
# MD033: Inline HTML
13-
MD033:
14-
allowed_elements: [p, img]
15-
1616
# MD025: Multiple top-level headings allowed
1717
MD025: false
1818

19-
# MD004: Unordered list style - allow different styles in sublists
20-
MD004:
21-
style: sublist
19+
# MD033: Inline HTML
20+
MD033:
21+
allowed_elements: [p, img]

adk/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,4 +148,7 @@ docker compose down -v
148148
[DuckDuckGo]: https://duckduckgo.com
149149
[Docker Compose]: https://github.com/docker/compose
150150
[Docker Desktop]: https://www.docker.com/products/docker-desktop/
151+
[Docker Engine]: https://docs.docker.com/engine/
151152
[Docker Model Runner]: https://docs.docker.com/ai/model-runner/
153+
[Docker Model Runner requirements]: https://docs.docker.com/ai/model-runner/
154+
[Docker Offload]: https://www.docker.com/products/docker-offload/

agno/README.md

Lines changed: 51 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# 🧠 Agno GitHub Issue Analyzer
22

3-
This project demonstrates a **collaborative multi-agent system** built with [Agno], where specialized agents work together to analyze GitHub repositories. The **Coordinator** orchestrates the workflow between a **GitHub Issue Retriever** agent that fetches open issues via the **GitHub MCP Server**, and a **Writer** agent that summarizes and categorizes them into a comprehensive markdown report.
3+
This project demonstrates a **collaborative multi-agent system** built with [Agno], where specialized
4+
agents work together to analyze GitHub repositories. The **Coordinator** orchestrates the workflow
5+
between a **GitHub Issue Retriever** agent that fetches open issues via the **GitHub MCP Server**, and
6+
a **Writer** agent that summarizes and categorizes them into a comprehensive markdown report.
47

58
> [!Tip]
69
> ✨ No complex configuration needed — just add your GitHub token and run with a single command.
@@ -9,24 +12,28 @@ This project demonstrates a **collaborative multi-agent system** built with [Agn
912

1013
### Requirements
1114

12-
+ **[Docker Desktop](https://www.docker.com/products/docker-desktop/) 4.43.0+ or [Docker Engine](https://docs.docker.com/engine/)** installed
13-
+ **A laptop or workstation with a GPU** (e.g., a MacBook) for running open models locally. If you don't have a GPU, you can alternatively use [**Docker Offload**](https://www.docker.com/products/docker-offload).
14-
+ If you're using Docker Engine on Linux or Docker Desktop on Windows, ensure that the [Docker Model Runner requirements](https://docs.docker.com/ai/model-runner/) are met (specifically that GPU support is enabled) and the necessary drivers are installed
15-
+ If you're using Docker Engine on Linux, ensure you have Compose 2.38.1 or later installed
15+
+ **[Docker Desktop] 4.43.0+ or [Docker Engine]** installed.
16+
+ **A laptop or workstation with a GPU** (e.g., a MacBook) for running open models locally. If you
17+
don't have a GPU, you can alternatively use **[Docker Offload]**.
18+
+ If you're using [Docker Engine] on Linux or [Docker Desktop] on Windows, ensure that the
19+
[Docker Model Runner requirements] are met (specifically that GPU
20+
support is enabled) and the necessary drivers are installed.
21+
+ If you're using Docker Engine on Linux, ensure you have [Docker Compose] 2.38.1 or later installed.
1622
+ 🔑 GitHub Personal Access Token (for public repositories)
1723

1824
### Setup
1925

2026
1. **Create a GitHub Personal Access Token:**
21-
- Navigate to https://github.com/settings/personal-access-tokens
27+
- Navigate to <https://github.com/settings/personal-access-tokens>
2228
- Create a fine-grained token with **read access to public repositories**
2329

2430
![GitHub token permissions](./img/github-perms.png)
2531

2632
2. **Configure MCP secrets:**
2733
- Copy `.mcp.env.example` to `.mcp.env`
2834
- Add your GitHub token to the `.mcp.env` file:
29-
```bash
35+
36+
```sh
3037
GITHUB_PERSONAL_ACCESS_TOKEN=your_token_here
3138
```
3239

@@ -36,44 +43,49 @@ This project demonstrates a **collaborative multi-agent system** built with [Agn
3643
docker compose up --build
3744
```
3845

39-
Using Docker Offload with GPU support, you can run the same demo with a larger model that takes advantage of a more powerful GPU on the remote instance:
46+
Using Docker Offload with GPU support, you can run the same demo with a larger model that takes advantage
47+
of a more powerful GPU on the remote instance:
48+
4049
```sh
4150
docker compose -f compose.yaml -f compose.offload.yaml up --build
4251
```
4352

44-
That's all! The agents will spin up automatically. Open **http://localhost:3000** in your browser to interact with the multi-agent system.
53+
That's all! The agents will spin up automatically. Open **<http://localhost:3000>** in your browser to
54+
interact with the multi-agent system.
4555

4656
# 🧠 Inference Options
4757

48-
By default, this project uses [Docker Model Runner] to handle LLM inference locally — no internet connection or external API key is required.
58+
By default, this project uses [Docker Model Runner] to handle LLM inference locally — no internet
59+
connection or external API key is required.
4960

5061
If you’d prefer to use OpenAI instead:
5162

5263
1. Create a `secret.openai-api-key` file with your OpenAI API key:
5364

54-
```
55-
sk-...
56-
```
65+
```plaintext
66+
sk-...
67+
```
5768
5869
2. Restart the project with the OpenAI configuration:
5970
60-
```
61-
docker compose down -v
62-
docker compose -f compose.yaml -f compose.openai.yaml up
63-
```
71+
```sh
72+
docker compose down -v
73+
docker compose -f compose.yaml -f compose.openai.yaml up
74+
```
6475
6576
# ❓ What Can It Do?
6677
6778
Give it any public GitHub repository and watch the agents collaborate to deliver a comprehensive analysis:
6879
69-
- **Fetch Issues**: The GitHub agent retrieves all open issues with their details
70-
- **Analyze & Categorize**: The Writer agent classifies issues into categories (bugs, features, documentation)
71-
- **Generate Report**: Creates a structured markdown summary with issue links and descriptions
80+
+ **Fetch Issues**: The GitHub agent retrieves all open issues with their details
81+
+ **Analyze & Categorize**: The Writer agent classifies issues into categories (bugs, features, documentation)
82+
+ **Generate Report**: Creates a structured markdown summary with issue links and descriptions
7283
7384
**Example queries:**
74-
- `summarize the issues in the repo microsoft/vscode`
75-
- `analyze issues in facebook/react`
76-
- `categorize the problems in tensorflow/tensorflow`
85+
86+
+ `summarize the issues in the repo microsoft/vscode`
87+
+ `analyze issues in facebook/react`
88+
+ `categorize the problems in tensorflow/tensorflow`
7789
7890
The **Coordinator** orchestrates the entire workflow, ensuring each agent performs its specialized task efficiently.
7991
@@ -122,21 +134,22 @@ flowchart TD
122134
end
123135
```
124136

125-
- The **Coordinator** orchestrates the multi-agent workflow using Agno's team coordination
126-
- **GitHub Issue Retriever** connects to GitHub via the secure MCP Gateway
127-
- **Writer** processes and categorizes the retrieved data into structured reports
128-
- All agents use **Docker Model Runner** with Qwen 3 for local LLM inference
129-
- The **Next.js UI** provides an intuitive chat interface for repository analysis
137+
+ The **Coordinator** orchestrates the multi-agent workflow using Agno's team coordination
138+
+ **GitHub Issue Retriever** connects to GitHub via the secure MCP Gateway
139+
+ **Writer** processes and categorizes the retrieved data into structured reports
140+
+ All agents use **[Docker Model Runner]** with Qwen 3 for local LLM inference
141+
+ The **Next.js UI** provides an intuitive chat interface for repository analysis
130142

131143
# 🛠️ Agent Configuration
132144

133145
The agents are configured in `agents.yaml` with specific roles and instructions:
134146

135-
- **GitHub Agent**: Specialized in retrieving GitHub issues with precise API calls
136-
- **Writer Agent**: Expert in summarization and categorization with markdown formatting
137-
- **Coordinator Team**: Orchestrates the workflow between specialized agents
147+
+ **GitHub Agent**: Specialized in retrieving GitHub issues with precise API calls
148+
+ **Writer Agent**: Expert in summarization and categorization with markdown formatting
149+
+ **Coordinator Team**: Orchestrates the workflow between specialized agents
138150

139-
Each agent uses the **Docker Model Runner** for inference, ensuring consistent performance without external API dependencies.
151+
Each agent uses the **[Docker Model Runner]** for inference, ensuring consistent performance without
152+
external API dependencies.
140153

141154
# 🧹 Cleanup
142155

@@ -148,12 +161,15 @@ docker compose down -v
148161

149162
# 📎 Credits
150163

151-
- [Agno] - Multi-agent framework
152-
- [GitHub MCP Server] - Model Context Protocol integration
153-
- [Docker Compose] - Container orchestration
164+
+ [Agno] - Multi-agent framework
165+
+ [GitHub MCP Server] - Model Context Protocol integration
166+
+ [Docker Compose] - Container orchestration
154167

155168
[Agno]: https://github.com/agno-agi/agno
156169
[GitHub MCP Server]: https://github.com/modelcontextprotocol/servers
157170
[Docker Compose]: https://github.com/docker/compose
158171
[Docker Desktop]: https://www.docker.com/products/docker-desktop/
172+
[Docker Engine]: https://docs.docker.com/engine/
159173
[Docker Model Runner]: https://docs.docker.com/ai/model-runner/
174+
[Docker Model Runner requirements]: https://docs.docker.com/ai/model-runner/
175+
[Docker Offload]: https://www.docker.com/products/docker-offload/

agno/agent-ui/README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Agent UI
22

3-
A modern chat interface for AI agents built with Next.js, Tailwind CSS, and TypeScript. This template provides a ready-to-use UI for interacting with Agno agents.
3+
A modern chat interface for AI agents built with Next.js, Tailwind CSS, and TypeScript. This template
4+
provides a ready-to-use UI for interacting with Agno agents.
45

5-
<img src="https://github.com/user-attachments/assets/7765fae5-a813-46cb-993b-904af9bc1672" alt="agent-ui" style="border-radius: 10px; width: 100%; max-width: 800px;" />
6+
<img src="https://github.com/user-attachments/assets/7765fae5-a813-46cb-993b-904af9bc1672" alt="agent-ui"
7+
style="border-radius: 10px; width: 100%; max-width: 800px;" />
68

79
## Features
810

@@ -18,7 +20,9 @@ A modern chat interface for AI agents built with Next.js, Tailwind CSS, and Type
1820

1921
### Prerequisites
2022

21-
Before setting up Agent UI, you may want to have an Agno Playground running. If you haven't set up the Agno Playground yet, follow the [official guide](https://agno.link/agent-ui#connect-to-local-agents) to run the Playground locally.
23+
Before setting up Agent UI, you may want to have an Agno Playground running. If you haven't set up the
24+
Agno Playground yet, follow the [official guide](https://agno.link/agent-ui#connect-to-local-agents)
25+
to run the Playground locally.
2226

2327
### Installation
2428

@@ -32,28 +36,29 @@ npx create-agent-ui@latest
3236

3337
1. Clone the repository:
3438

35-
```bash
36-
git clone https://github.com/agno-agi/agent-ui.git
37-
cd agent-ui
38-
```
39+
```bash
40+
git clone https://github.com/agno-agi/agent-ui.git
41+
cd agent-ui
42+
```
3943

4044
2. Install dependencies:
4145

42-
```bash
43-
pnpm install
44-
```
46+
```bash
47+
pnpm install
48+
```
4549

4650
3. Start the development server:
4751

48-
```bash
49-
pnpm dev
50-
```
52+
```bash
53+
pnpm dev
54+
```
5155

5256
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
5357

5458
## Connecting to an Agent Backend
5559

56-
By default Agent UI connects to `http://localhost:7777`. You can easily change this by hovering over the endpoint URL and clicking the edit option.
60+
By default Agent UI connects to `http://localhost:7777`. You can easily change this by hovering over the
61+
endpoint URL and clicking the edit option.
5762

5863
The default endpoint works with the standard Agno Playground setup described in the [official documentation](https://agno.link/agent-ui#connect-to-local-agents).
5964

0 commit comments

Comments
 (0)