Skip to content

Commit 63e032f

Browse files
artbergerartberger
authored
Merge pull request #178 from kagent-dev/doc-fixes
Doc fixes
2 parents 7b3fd2e + 523430a commit 63e032f

File tree

6 files changed

+98
-43
lines changed

6 files changed

+98
-43
lines changed

‎.github/workflows/update-ref-docs.yaml‎

Lines changed: 53 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ jobs:
9292
# Create index file with frontmatter
9393
echo '---' > src/app/docs/kagent/resources/api-ref/page.mdx
9494
echo 'title: "API Reference"' >> src/app/docs/kagent/resources/api-ref/page.mdx
95-
echo 'sectionOrder: 1' >> src/app/docs/kagent/resources/api-ref/page.mdx
95+
echo 'pageOrder: 1' >> src/app/docs/kagent/resources/api-ref/page.mdx
9696
echo 'description: "kagent API reference documentation"' >> src/app/docs/kagent/resources/api-ref/page.mdx
9797
echo '---' >> src/app/docs/kagent/resources/api-ref/page.mdx
9898
echo '' >> src/app/docs/kagent/resources/api-ref/page.mdx
@@ -135,10 +135,57 @@ jobs:
135135

136136
echo "Processing kagent Helm chart..."
137137

138+
echo "Chart directory contents:"
139+
ls -la "$GITHUB_WORKSPACE/kagent/helm/kagent/"
140+
141+
echo "Chart.yaml contents:"
142+
cat "$GITHUB_WORKSPACE/kagent/helm/kagent/Chart.yaml" || echo "Chart.yaml not found!"
143+
144+
echo "Values.yaml contents (first 20 lines):"
145+
head -20 "$GITHUB_WORKSPACE/kagent/helm/kagent/values.yaml" || echo "values.yaml not found!"
146+
147+
# Generate the helm documentation
148+
echo "Running helm-docs..."
149+
150+
# Debug: Show all available paths
151+
echo "Available paths:"
152+
echo "GITHUB_WORKSPACE: $GITHUB_WORKSPACE"
153+
echo "Current directory: $PWD"
154+
echo "kagent repo path: $GITHUB_WORKSPACE/kagent"
155+
echo "kagent helm path: $GITHUB_WORKSPACE/kagent/helm"
156+
echo "kagent chart path: $GITHUB_WORKSPACE/kagent/helm/kagent"
157+
158+
# List all helm directories to see what's available
159+
echo "All helm directories:"
160+
find "$GITHUB_WORKSPACE/kagent/helm" -name "Chart.yaml" -type f 2>/dev/null | head -10
161+
162+
# Check if the specific chart directory exists and what's in it
163+
echo "Checking chart directory:"
164+
if [ -d "$GITHUB_WORKSPACE/kagent/helm/kagent" ]; then
165+
echo "Chart directory exists"
166+
ls -la "$GITHUB_WORKSPACE/kagent/helm/kagent/"
167+
echo "Chart.yaml exists: $([ -f "$GITHUB_WORKSPACE/kagent/helm/kagent/Chart.yaml" ] && echo "YES" || echo "NO")"
168+
echo "Values.yaml exists: $([ -f "$GITHUB_WORKSPACE/kagent/helm/kagent/values.yaml" ] && echo "YES" || echo "NO")"
169+
else
170+
echo "Chart directory does NOT exist"
171+
fi
172+
138173
# Generate the helm documentation
139174
go run github.com/norwoodj/helm-docs/cmd/[email protected] \
140175
--chart-search-root "$GITHUB_WORKSPACE/kagent/helm/kagent" \
141176
--dry-run > "src/app/docs/kagent/resources/helm/temp.mdx"
177+
178+
# Go back to website directory
179+
cd "$GITHUB_WORKSPACE/website"
180+
181+
echo "Generated helm-docs output (first 50 lines):"
182+
head -50 "src/app/docs/kagent/resources/helm/temp.mdx"
183+
184+
echo "Generated helm-docs output (last 50 lines):"
185+
tail -50 "src/app/docs/kagent/resources/helm/temp.mdx"
186+
187+
echo "Total lines generated:"
188+
wc -l "src/app/docs/kagent/resources/helm/temp.mdx"
142189

143190
# Remove badge line and following empty line
144191
# (might be replaced by helm docs template in the future)
@@ -150,7 +197,7 @@ jobs:
150197
# Add frontmatter
151198
echo '---' > "src/app/docs/kagent/resources/helm/page.mdx"
152199
echo 'title: "Helm Chart Configuration"' >> "src/app/docs/kagent/resources/helm/page.mdx"
153-
echo 'sectionOrder: 2' >> "src/app/docs/kagent/resources/helm/page.mdx"
200+
echo 'pageOrder: 2' >> "src/app/docs/kagent/resources/helm/page.mdx"
154201
echo 'description: "kagent Helm chart configuration reference"' >> "src/app/docs/kagent/resources/helm/page.mdx"
155202
echo '---' >> "src/app/docs/kagent/resources/helm/page.mdx"
156203
echo '' >> "src/app/docs/kagent/resources/helm/page.mdx"
@@ -170,6 +217,9 @@ jobs:
170217
echo "=== Debug: After creating index file ==="
171218
echo "Content directory structure:"
172219
ls -la src/app/docs/kagent/resources/helm/
220+
221+
echo "Final generated file contents (first 50 lines):"
222+
head -50 "src/app/docs/kagent/resources/helm/page.mdx"
173223

174224
- name: Create Pull Request
175225
uses: peter-evans/create-pull-request@v6
@@ -182,7 +232,7 @@ jobs:
182232
body: |
183233
Automated API and kagent Helm chart documentation update based on the latest commit [`${{ env.KAGENT_COMMIT }}`](https://github.com/${{ github.repository_owner }}/kagent/commit/${{ env.KAGENT_COMMIT }}) to `main` in the **kagent** repository.
184234
185-
This PR was automatically generated by the [**Update Reference documentation** workflow](https://github.com/kagent-dev/website/actions/workflows/update-ref-docs.yaml).
235+
This PR was automatically generated by the [**Update Reference documentation** workflow](https://github.com/${{ github.repository_owner }}/website/actions/workflows/update-ref-docs.yaml).
186236
branch: api-gen-update
187237
branch-suffix: timestamp
188238
delete-branch: true

‎src/app/docs/kagent/getting-started/quickstart/page.mdx‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,24 +26,23 @@ To run the AI agents you'll also need an [OpenAI](https://openai.com) API key. Y
2626

2727
## Installing kagent
2828

29-
1. Set the OpenAI API key as an environment variable:
29+
1. Set the OpenAI API key as an environment variable.
3030

31-
```bash
32-
export OPENAI_API_KEY="your-api-key-here"
33-
```
31+
```bash
32+
export OPENAI_API_KEY="your-api-key-here"
33+
```
3434

35-
2. Download the kagent CLI:
35+
2. Download the kagent CLI.
3636

37-
```bash
38-
# Download/run the install script
39-
curl https://raw.githubusercontent.com/kagent-dev/kagent/refs/heads/main/scripts/get-kagent | bash
40-
```
37+
```bash
38+
curl https://raw.githubusercontent.com/kagent-dev/kagent/refs/heads/main/scripts/get-kagent | bash
39+
```
4140

4241
3. Install the kmcp CRDs so that you can create MCP servers.
4342

44-
```sh
43+
```bash
4544
helm install kmcp-crds oci://ghcr.io/kagent-dev/kmcp/helm/kmcp-crds \
46-
--namespace kmcp-system \
45+
--namespace kagent \
4746
--create-namespace
4847
```
4948

@@ -52,6 +51,8 @@ curl https://raw.githubusercontent.com/kagent-dev/kagent/refs/heads/main/scripts
5251
```bash
5352
kagent install
5453
```
54+
55+
Example output:
5556

5657
```console
5758
kagent installed successfully

‎src/app/docs/kagent/getting-started/tracing/page.mdx‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,18 +65,21 @@ helm upgrade --install jaeger jaegertracing/jaeger \
6565

6666
The following steps include commands to install or upgrade the kagent Helm release.
6767

68-
1. Set the OpenAI API key as an environment variable:
68+
1. Set the OpenAI API key as an environment variable.
6969

7070
```bash
7171
export OPENAI_API_KEY="your-api-key-here"
7272
```
7373

74-
2. If you did not already, install the kagent CRDs.
74+
2. If you did not already, install the kagent and kmcp CRDs.
7575

7676
```bash
7777
helm upgrade --install kagent-crds oci://ghcr.io/kagent-dev/kagent/helm/kagent-crds \
7878
--namespace kagent \
7979
--create-namespace
80+
81+
helm upgrade --install kmcp-crds oci://ghcr.io/kagent-dev/kmcp/helm/kmcp-crds \
82+
--namespace kagent
8083
```
8184

8285
3. If you already installed kagent, get your current Helm release values.
@@ -85,7 +88,7 @@ The following steps include commands to install or upgrade the kagent Helm relea
8588
helm get values kagent -n kagent > values.yaml
8689
```
8790

88-
3. Create or update your values file to include the following settings to enable tracing.
91+
4. Create or update your values file to include the following settings to enable tracing.
8992

9093
```yaml
9194
otel:
@@ -96,7 +99,7 @@ The following steps include commands to install or upgrade the kagent Helm relea
9699
endpoint: http://jaeger-collector.jaeger.svc.cluster.local:4317
97100
```
98101
99-
4. Install or upgrade the kagent Helm chart with the tracing details.
102+
5. Install or upgrade the kagent Helm chart with the tracing details.
100103
101104
```bash
102105
helm upgrade -i kagent oci://ghcr.io/kagent-dev/kagent/helm/kagent \

‎src/app/docs/kagent/introduction/installation/page.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ This guide covers ways to install and configure kagent in your Kubernetes enviro
1818

1919
### Using kagent CLI (Recommended)
2020

21-
1. Set the OpenAI API key as an environment variable:
21+
1. Set the OpenAI API key as an environment variable.
2222

2323
```bash
2424
export OPENAI_API_KEY="your-api-key-here"
2525
```
2626

27-
2. Download the kagent CLI:
27+
2. Download the kagent CLI.
2828

2929
```bash
3030
# Download/run the install script
@@ -33,9 +33,9 @@ This guide covers ways to install and configure kagent in your Kubernetes enviro
3333

3434
3. Install the kmcp CRDs so that you can create MCP servers.
3535

36-
```sh
36+
```bash
3737
helm install kmcp-crds oci://ghcr.io/kagent-dev/kmcp/helm/kmcp-crds \
38-
--namespace kmcp-system \
38+
--namespace kagent \
3939
--create-namespace
4040
```
4141

‎src/app/docs/kagent/resources/release-notes/page.mdx‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ The `apiVersion` field in the kagent CRDs is now `kagent.dev/v1alpha2`.
3737
Previously, the kagent installation included only one CRD Helm chart. Now, you install two CRD Helm charts: one for kagent CRDs and one for kmcp CRDs.
3838

3939
<Tabs tabs={[
40-
{ id: 'kagent', label: 'kagent CRD Helm chart' },
41-
{ id: 'kmcp', label: 'kmcp CRD Helm chart' }
40+
{ id: 'kagent-crds', label: 'kagent CRD Helm chart' },
41+
{ id: 'kmcp-crds', label: 'kmcp CRD Helm chart' }
4242
]} />
4343

44-
<div id="kagent-tab">
44+
<div id="kagent-crds-tab">
4545
kagent CRD Helm chart location (no change): `oci://ghcr.io/kagent-dev/kagent/helm/kagent-crds`
4646

4747
Example installation command:
@@ -52,13 +52,13 @@ Previously, the kagent installation included only one CRD Helm chart. Now, you i
5252
```
5353
</div>
5454

55-
<div id="kmcp-tab">
55+
<div id="kmcp-crds-tab">
5656
kmcp CRD Helm chart location: `oci://ghcr.io/kagent-dev/kmcp/helm/kmcp-crds`
5757

5858
Example installation command:
5959
```shell
6060
helm install kmcp-crds oci://ghcr.io/kagent-dev/kmcp/helm/kmcp-crds \
61-
--namespace kmcp-system \
61+
--namespace kagent \
6262
--create-namespace
6363
```
6464
</div>
@@ -120,17 +120,8 @@ Flip through the following tabs to understand the API differences between the ol
120120
<div id="kmcp-tab">
121121
kmcp example:
122122
* The kagent MCPServer includes the Grafana deployment details, with `stdio` as the transport type.
123-
* The Grafana API key is loaded separately in a Secret, which is more secure.
124123
```yaml
125-
apiVersion: v1
126-
kind: Secret
127-
metadata:
128-
name: grafana-api-key
129-
type: Opaque
130-
data:
131-
GRAFANA_API_KEY: my-base-64-ikey
132-
---
133-
apiVersion: kagent.dev/v1alpha2
124+
apiVersion: kagent.dev/v1alpha1
134125
kind: MCPServer
135126
metadata:
136127
name: grafana
@@ -147,6 +138,16 @@ Flip through the following tabs to understand the API differences between the ol
147138
secretRefs:
148139
- name: grafana-api-key
149140
transportType: "stdio"
141+
```
142+
* The Grafana API key is stored separately in a Secret, which is more secure.
143+
```yaml
144+
apiVersion: v1
145+
kind: Secret
146+
metadata:
147+
name: grafana-api-key
148+
type: Opaque
149+
data:
150+
GRAFANA_API_KEY: my-base-64-ikey
150151
```
151152
</div>
152153

@@ -322,7 +323,7 @@ Here are the 2 api defs:
322323

323324
### Top-level field for Agent APIs
324325

325-
A new top-level `type` field is added to the Agents API. For existing Agents, set the `type` to `Inline`, and then nest the previous Agent configuration under the `inline` setting.
326+
A new top-level `type` field is added to the Agents API. For existing Agents, set the `type` to `Declarative`, and then nest the previous Agent configuration inline under the `declarative` setting.
326327

327328
This change supports the new type for BYO agents.
328329

‎src/config/navigation.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,16 +101,16 @@
101101
"href": "/docs/kagent/supported-providers/azure-openai",
102102
"description": "Learn how to configure Azure OpenAI models in kagent."
103103
},
104-
{
105-
"title": "Gemini",
106-
"href": "/docs/kagent/supported-providers/gemini",
107-
"description": "Learn how to configure Gemini models in kagent."
108-
},
109104
{
110105
"title": "Google Vertex AI",
111106
"href": "/docs/kagent/supported-providers/google-vertexai",
112107
"description": "Learn how to configure Google Vertex AI models in kagent."
113108
},
109+
{
110+
"title": "Gemini",
111+
"href": "/docs/kagent/supported-providers/gemini",
112+
"description": "Learn how to configure Gemini models in kagent."
113+
},
114114
{
115115
"title": "Ollama",
116116
"href": "/docs/kagent/supported-providers/ollama",

0 commit comments

Comments
 (0)