Skip to content

Commit 4151853

Browse files
authored
docs: fix stale references and wording (#2184)
Fix stale and incorrect content across docs and templates. Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
1 parent cd4182f commit 4151853

7 files changed

Lines changed: 9 additions & 9 deletions

File tree

.github/ISSUE_TEMPLATE/1-bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ body:
1212
label: 📋 Prerequisites
1313
description: Please check these boxes before submitting the issue
1414
options:
15-
- label: I have searched the [existing issues](./issues) to avoid creating a duplicate
15+
- label: I have searched the [existing issues](https://github.com/kagent-dev/kagent/issues) to avoid creating a duplicate
1616
required: true
1717
- label: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/kagent-dev/kagent/blob/main/CODE_OF_CONDUCT.md)
1818
required: true

.github/ISSUE_TEMPLATE/2-feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ body:
1212
label: 📋 Prerequisites
1313
description: Please check these boxes before submitting your feature request
1414
options:
15-
- label: I have searched the [existing issues](./issues) to avoid creating a duplicate
15+
- label: I have searched the [existing issues](https://github.com/kagent-dev/kagent/issues) to avoid creating a duplicate
1616
required: true
1717
- label: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/kagent-dev/kagent/blob/main/CODE_OF_CONDUCT.md)
1818
required: true

.github/ISSUE_TEMPLATE/3-documentation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ body:
1212
label: 📋 Prerequisites
1313
description: Please check these boxes before submitting your documentation issue
1414
options:
15-
- label: I have searched the [existing issues](./issues) to avoid creating a duplicate
15+
- label: I have searched the [existing issues](https://github.com/kagent-dev/kagent/issues) to avoid creating a duplicate
1616
required: true
1717
- label: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/kagent-dev/kagent/blob/main/CODE_OF_CONDUCT.md)
1818
required: true

DEVELOPMENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Before you can run kagent in Kubernetes, you need to have the following tools in
1717
- **Kind** (v0.27.0+)
1818
- **kubectl** (v1.33.4+)
1919
- **Helm**
20-
- **Go** (v1.26.1+)
20+
- **Go** (v1.26.3+)
2121
- **Docker**
2222
- **Docker Buildx** (v0.23.0+)
2323
- **Make**

docs/OIDC_PROXY_AUTH_ARCHITECTURE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# OIDC Proxy Authentication Architecture
22

3-
This document describes the authentication architecture introduced in the `feature/oidc-proxy-auth` branch.
3+
This document describes the OIDC proxy-based authentication architecture in kagent.
44

55
## Overview
66

7-
This PR adds OIDC proxy-based authentication to Kagent, allowing integration with enterprise identity providers via oauth2-proxy. The architecture follows a "trust the proxy" model where an upstream reverse proxy (oauth2-proxy) handles OIDC authentication and injects JWT tokens into requests.
7+
kagent supports OIDC proxy-based authentication, allowing integration with enterprise identity providers via oauth2-proxy. The architecture follows a "trust the proxy" model where an upstream reverse proxy (oauth2-proxy) handles OIDC authentication and injects JWT tokens into requests.
88

99
## Authentication Flow
1010

docs/substrate-agentharness-lifecycle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Substrate AgentHarness Lifecycle
22

3-
This branch should use a single ownership model for `runtime: substrate` harnesses.
3+
kagent uses a single ownership model for `runtime: substrate` harnesses.
44

55
## Ownership
66

python/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Python
88

9-
Firstly setup a virtual environment:
9+
First, set up a virtual environment:
1010
```bash
1111
uv venv .venv
1212
```
@@ -27,6 +27,6 @@ uv sync --all-extras
2727

2828
The python code in this project uses the UV workspaces to manage the dependencies. You can read about them [here](https://docs.astral.sh/uv/concepts/projects/workspaces/).
2929

30-
The package directory contains various sub-packages which comprise the kagent engine. Each framework which kagent supports has its own package. Currently that is only ADK.
30+
The package directory contains various sub-packages which comprise the kagent engine. Each framework which kagent supports has its own package.
3131

3232
In addition there is a top-level kagent package which contains the main entry point for the engine. In the future we may want to have separate entrypoints for each framework to reduce the number of dependencies we have to install.

0 commit comments

Comments
 (0)