Skip to content

Commit 5af2e6e

Browse files
authored
docs: fix duplicate descriptions and broken link in README (#2068)
- Replace repeated intro sentence in Core Principles with a concrete Kubernetes Native description - Remove redundant Architecture section preamble (same sentence appeared three times) - Fix `markdownlint-disable` to `markdownlint-enable` after the HTML navigation table - Remove broken link to custom-models page (404) Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
1 parent 4e14aa5 commit 5af2e6e

1 file changed

Lines changed: 3 additions & 5 deletions

File tree

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
</td>
5656
</tr>
5757
</table>
58-
<!-- markdownlint-disable MD033 -->
58+
<!-- markdownlint-enable MD033 -->
5959

6060
---
6161

@@ -69,13 +69,13 @@
6969
### Core Concepts
7070

7171
- **Agents**: Agents are the main building block of kagent. They are a system prompt, a set of tools and agents, and an LLM configuration represented with a Kubernetes custom resource called "Agent".
72-
- **LLM Providers**: Kagent supports multiple LLM providers, including [OpenAI](https://kagent.dev/docs/kagent/supported-providers/openai), [Azure OpenAI](https://kagent.dev/docs/kagent/supported-providers/azure-openai), [Anthropic](https://kagent.dev/docs/kagent/supported-providers/anthropic), [Google Vertex AI](https://kagent.dev/docs/kagent/supported-providers/google-vertexai), [Ollama](https://kagent.dev/docs/kagent/supported-providers/ollama) and any other [custom providers and models](https://kagent.dev/docs/kagent/supported-providers/custom-models) accessible via AI gateways. Providers are represented by the ModelConfig resource.
72+
- **LLM Providers**: Kagent supports multiple LLM providers, including [OpenAI](https://kagent.dev/docs/kagent/supported-providers/openai), [Azure OpenAI](https://kagent.dev/docs/kagent/supported-providers/azure-openai), [Anthropic](https://kagent.dev/docs/kagent/supported-providers/anthropic), [Google Vertex AI](https://kagent.dev/docs/kagent/supported-providers/google-vertexai), [Ollama](https://kagent.dev/docs/kagent/supported-providers/ollama) and any other custom providers and models accessible via AI gateways. Providers are represented by the ModelConfig resource.
7373
- **MCP Tools**: Agents can connect to any MCP server that provides tools. Kagent comes with an MCP server with tools for Kubernetes, Istio, Helm, Argo, Prometheus, Grafana, Cilium, and others. All tools are Kubernetes custom resources (ToolServers) and can be used by multiple agents.
7474
- **Observability**: Kagent supports [OpenTelemetry tracing](https://kagent.dev/docs/kagent/getting-started/tracing), which allows you to monitor what's happening with your agents and tools.
7575

7676
### Core Principles
7777

78-
- **Kubernetes Native**: Kagent is designed to be easy to understand and use, and to provide a flexible and powerful way to build and manage AI agents.
78+
- **Kubernetes Native**: Agents and tools are managed as Kubernetes custom resources using familiar `kubectl` workflows.
7979
- **Extensible**: Kagent is designed to be extensible, so you can add your own agents and tools.
8080
- **Flexible**: Kagent is designed to be flexible, to suit any AI agent use case.
8181
- **Observable**: Kagent is designed to be observable, so you can monitor the agents and tools using all common monitoring frameworks.
@@ -84,8 +84,6 @@
8484

8585
### Architecture
8686

87-
The kagent framework is designed to be easy to understand and use, and to provide a flexible and powerful way to build and manage AI agents.
88-
8987
<div align="center">
9088
<img src="img/arch.png" alt="kagent" width="500">
9189
</div>

0 commit comments

Comments
 (0)