Skip to content

Commit 49900f2

Browse files
artbergerartberger
authored
Merge pull request #168 from kagent-dev/adb-fixes
Fix navigation
2 parents 3c11c8c + 9c9a0eb commit 49900f2

9 files changed

Lines changed: 85 additions & 114 deletions

File tree

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

Lines changed: 56 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -90,25 +90,25 @@ jobs:
9090
rm -f crd-ref-docs-config.yaml
9191
9292
# Create index file with frontmatter
93-
echo '---' > src/app/docs/kagent/resources/api/page.mdx
94-
echo 'title: "API Reference"' >> src/app/docs/kagent/resources/api/page.mdx
95-
echo 'sectionOrder: 1' >> src/app/docs/kagent/resources/api/page.mdx
96-
echo 'description: "kagent API reference documentation"' >> src/app/docs/kagent/resources/api/page.mdx
97-
echo '---' >> src/app/docs/kagent/resources/api/page.mdx
98-
echo '' >> src/app/docs/kagent/resources/api/page.mdx
99-
echo 'export const metadata = {' >> src/app/docs/kagent/resources/api/page.mdx
100-
echo ' title: "API Reference",' >> src/app/docs/kagent/resources/api/page.mdx
101-
echo ' description: "kagent API reference documentation",' >> src/app/docs/kagent/resources/api/page.mdx
102-
echo ' author: "kagent.dev"' >> src/app/docs/kagent/resources/api/page.mdx
103-
echo '};' >> src/app/docs/kagent/resources/api/page.mdx
104-
echo '' >> src/app/docs/kagent/resources/api/page.mdx
105-
cat "./out.md" >> src/app/docs/kagent/resources/api/page.mdx
93+
echo '---' > src/app/docs/kagent/resources/api-ref/page.mdx
94+
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
96+
echo 'description: "kagent API reference documentation"' >> src/app/docs/kagent/resources/api-ref/page.mdx
97+
echo '---' >> src/app/docs/kagent/resources/api-ref/page.mdx
98+
echo '' >> src/app/docs/kagent/resources/api-ref/page.mdx
99+
echo 'export const metadata = {' >> src/app/docs/kagent/resources/api-ref/page.mdx
100+
echo ' title: "API Reference",' >> src/app/docs/kagent/resources/api-ref/page.mdx
101+
echo ' description: "kagent API reference documentation",' >> src/app/docs/kagent/resources/api-ref/page.mdx
102+
echo ' author: "kagent.dev"' >> src/app/docs/kagent/resources/api-ref/page.mdx
103+
echo '};' >> src/app/docs/kagent/resources/api-ref/page.mdx
104+
echo '' >> src/app/docs/kagent/resources/api-ref/page.mdx
105+
cat "./out.md" >> src/app/docs/kagent/resources/api-ref/page.mdx
106106
107107
# Remove temporary file
108108
rm -f "./out.md"
109109
110110
# Verify the output file was created
111-
if [ ! -f "src/app/docs/kagent/resources/api/page.mdx" ]; then
111+
if [ ! -f "src/app/docs/kagent/resources/api-ref/page.mdx" ]; then
112112
echo "Error: Failed to create API docs page"
113113
exit 1
114114
fi
@@ -127,63 +127,45 @@ jobs:
127127
# Create directory for Helm docs
128128
mkdir -p src/app/docs/kagent/resources/helm/
129129

130-
# Generate Helm Docs with helm-docs
131-
for chart in "kagent:helm" "kagent-crds:crds"; do
132-
IFS=: read -r dir file <<< "$chart"
133-
echo "Processing chart: $dir -> $file"
134-
135-
if [ ! -d "$GITHUB_WORKSPACE/kagent/helm/$dir" ]; then
136-
echo "Warning: Helm chart directory $dir not found, skipping"
137-
continue
138-
fi
139-
140-
# Generate the helm documentation
141-
go run github.com/norwoodj/helm-docs/cmd/helm-docs@v1.14.2 \
142-
--chart-search-root "$GITHUB_WORKSPACE/kagent/helm/$dir" \
143-
--dry-run > "src/app/docs/kagent/resources/helm/${file}/temp.mdx"
144-
145-
# Remove badge line and following empty line
146-
# (might be replaced by helm docs template in the future)
147-
sed -i '/!\[Version:/,/^$/d' "src/app/docs/kagent/resources/helm/${file}/temp.mdx"
148-
149-
# Remove backticks from the Default column in the table
150-
sed -i 's/| `\([^`]*\)` |/| \1 |/g' "src/app/docs/kagent/resources/helm/${file}/temp.mdx"
151-
152-
# Add frontmatter based on chart type
153-
if [ "$file" = "helm" ]; then
154-
echo '---' > "src/app/docs/kagent/resources/helm/${file}/page.mdx"
155-
echo 'title: "Helm Chart Configuration"' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
156-
echo 'sectionOrder: 2' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
157-
echo 'description: "kagent Helm chart configuration reference"' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
158-
echo '---' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
159-
echo '' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
160-
echo 'export const metadata = {' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
161-
echo ' title: "Helm Chart Configuration",' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
162-
echo ' description: "kagent Helm chart configuration reference",' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
163-
echo ' author: "kagent.dev"' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
164-
echo '};' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
165-
echo '' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
166-
else
167-
echo '---' > "src/app/docs/kagent/resources/helm/${file}/page.mdx"
168-
echo 'title: "CRDs Chart Configuration"' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
169-
echo 'sectionOrder: 3' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
170-
echo 'description: "kagent CRDs Helm chart configuration reference"' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
171-
echo '---' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
172-
echo '' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
173-
echo 'export const metadata = {' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
174-
echo ' title: "CRDs Chart Configuration",' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
175-
echo ' description: "kagent CRDs Helm chart configuration reference",' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
176-
echo ' author: "kagent.dev"' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
177-
echo '};' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
178-
echo '' >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
179-
fi
180-
181-
# Append the processed helm documentation
182-
cat "src/app/docs/kagent/resources/helm/${file}/temp.mdx" >> "src/app/docs/kagent/resources/helm/${file}/page.mdx"
183-
184-
# Clean up temporary file
185-
rm -f "src/app/docs/kagent/resources/helm/${file}/temp.mdx"
186-
done
130+
# Generate Helm Docs for kagent chart
131+
if [ ! -d "$GITHUB_WORKSPACE/kagent/helm/kagent" ]; then
132+
echo "Error: kagent Helm chart directory not found"
133+
exit 1
134+
fi
135+
136+
echo "Processing kagent Helm chart..."
137+
138+
# Generate the helm documentation
139+
go run github.com/norwoodj/helm-docs/cmd/helm-docs@v1.14.2 \
140+
--chart-search-root "$GITHUB_WORKSPACE/kagent/helm/kagent" \
141+
--dry-run > "src/app/docs/kagent/resources/helm/temp.mdx"
142+
143+
# Remove badge line and following empty line
144+
# (might be replaced by helm docs template in the future)
145+
sed -i '/!\[Version:/,/^$/d' "src/app/docs/kagent/resources/helm/temp.mdx"
146+
147+
# Remove backticks from the Default column in the table
148+
sed -i 's/| `\([^`]*\)` |/| \1 |/g' "src/app/docs/kagent/resources/helm/temp.mdx"
149+
150+
# Add frontmatter
151+
echo '---' > "src/app/docs/kagent/resources/helm/page.mdx"
152+
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"
154+
echo 'description: "kagent Helm chart configuration reference"' >> "src/app/docs/kagent/resources/helm/page.mdx"
155+
echo '---' >> "src/app/docs/kagent/resources/helm/page.mdx"
156+
echo '' >> "src/app/docs/kagent/resources/helm/page.mdx"
157+
echo 'export const metadata = {' >> "src/app/docs/kagent/resources/helm/page.mdx"
158+
echo ' title: "Helm Chart Configuration",' >> "src/app/docs/kagent/resources/helm/page.mdx"
159+
echo ' description: "kagent Helm chart configuration reference",' >> "src/app/docs/kagent/resources/helm/page.mdx"
160+
echo ' author: "kagent.dev"' >> "src/app/docs/kagent/resources/helm/page.mdx"
161+
echo '};' >> "src/app/docs/kagent/resources/helm/page.mdx"
162+
echo '' >> "src/app/docs/kagent/resources/helm/page.mdx"
163+
164+
# Append the processed helm documentation
165+
cat "src/app/docs/kagent/resources/helm/temp.mdx" >> "src/app/docs/kagent/resources/helm/page.mdx"
166+
167+
# Clean up temporary file
168+
rm -f "src/app/docs/kagent/resources/helm/temp.mdx"
187169

188170
echo "=== Debug: After creating index file ==="
189171
echo "Content directory structure:"
@@ -194,11 +176,11 @@ jobs:
194176
with:
195177
token: ${{ secrets.GITHUB_TOKEN }}
196178
path: website
197-
commit-message: "docs: Update API and Helm reference docs"
179+
commit-message: "docs: Update API and kagent Helm reference docs"
198180
signoff: true
199-
title: "Update API and Helm reference docs"
181+
title: "Update API and kagent Helm reference docs"
200182
body: |
201-
Automated API and Helm 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.
183+
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.
202184
203185
This PR was automatically generated by the [**Update Reference documentation** workflow](https://github.com/kagent-dev/website/actions/workflows/update-ref-docs.yaml).
204186
branch: api-gen-update

‎public/sitemap.xml‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@
162162
</url>
163163

164164
<url>
165-
<loc>https://kagent.dev/docs/kagent/resources/api</loc>
165+
<loc>https://kagent.dev/docs/kagent/resources/api-ref</loc>
166166
<lastmod>2025-08-15</lastmod>
167167
<changefreq>weekly</changefreq>
168168
<priority>0.8</priority>
@@ -175,6 +175,13 @@
175175
<priority>0.8</priority>
176176
</url>
177177

178+
<url>
179+
<loc>https://kagent.dev/docs/kagent/resources/helm</loc>
180+
<lastmod>2025-08-15</lastmod>
181+
<changefreq>weekly</changefreq>
182+
<priority>0.8</priority>
183+
</url>
184+
178185
<url>
179186
<loc>https://kagent.dev/docs/kagent/resources</loc>
180187
<lastmod>2025-08-15</lastmod>
@@ -309,7 +316,7 @@
309316
</url>
310317

311318
<url>
312-
<loc>https://kagent.dev/docs/kmcp/reference/api</loc>
319+
<loc>https://kagent.dev/docs/kmcp/reference/api-ref</loc>
313320
<lastmod>2025-08-15</lastmod>
314321
<changefreq>weekly</changefreq>
315322
<priority>0.8</priority>

src/app/docs/kagent/resources/api/page.mdx renamed to src/app/docs/kagent/resources/api-ref/page.mdx

File renamed without changes.

‎src/app/docs/kagent/resources/helm/crds/page.mdx‎

Lines changed: 0 additions & 18 deletions
This file was deleted.

src/app/docs/kagent/resources/helm/helm/page.mdx renamed to src/app/docs/kagent/resources/helm/page.mdx

File renamed without changes.

‎src/app/docs/kagent/resources/page.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ import QuickLink from '@/components/quick-link';
1919
</div>
2020

2121
<div className="grid grid-cols-1 md:grid-cols-2 gap-6 mb-12">
22-
<QuickLink title="API docs" description="kagent API reference docs" href="/docs/kagent/resources/api" />
22+
<QuickLink title="API docs" description="kagent API reference docs" href="/docs/kagent/resources/api-ref" />
2323
<QuickLink title="Helm Chart Configuration" description="kagent Helm chart configuration reference" href="/docs/kagent/resources/helm/helm" />
24-
<QuickLink title="CRDs Chart Configuration" description="kagent CRDs Helm chart configuration reference" href="/docs/kagent/resources/helm/crds" />
25-
<QuickLink title="Troubleshooting Guide" description="Get help with common issues and problems when using kagent." href="/docs/kagent/resources/troubleshooting" />
2624
<QuickLink title="Frequently Asked Questions" description="Find answers to common questions about kagent." href="/docs/kagent/resources/faq" />
25+
<QuickLink title="Release Notes" description="Review the release notes for kagent." href="/docs/kagent/resources/release-notes" />
26+
<QuickLink title="Troubleshooting Guide" description="Get help with common issues and problems when using kagent." href="/docs/kagent/resources/troubleshooting" />
2727
<QuickLink title="Quick Start Guide" description="Get up and running quickly with kagent." href="/docs/kagent/getting-started/quickstart" />
2828
<QuickLink title="Official GitHub Repository" description="Access the source code and contribute to kagent development." href="https://github.com/kagent-dev/kagent" />
2929
<QuickLink title="Contribution Guide" description="Learn how to contribute to the kagent project." href="https://github.com/kagent-dev/kagent/blob/main/CONTRIBUTION.md" />

src/app/docs/kmcp/reference/api/page.mdx renamed to src/app/docs/kmcp/reference/api-ref/page.mdx

File renamed without changes.

‎src/app/docs/kmcp/reference/page.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import QuickLink from '@/components/quick-link';
1313
</div>
1414

1515
<div className="grid grid-cols-1 md:grid-cols-2 gap-6 mb-12">
16-
<QuickLink title="API docs" description="kmcp API reference docs" href="/docs/kmcp/reference/api" />
16+
<QuickLink title="API docs" description="kmcp API reference docs" href="/docs/kmcp/reference/api-ref" />
1717
<QuickLink title="kmcp add-tool" description="Generate an MCP tool boilerplate that you can use as the base to create your own." href="/docs/kmcp/reference/kmcp-add-tool" />
1818
<QuickLink title="kmcp build" description="Build a Docker image for your MCP server." href="/docs/kmcp/reference/kmcp-build" />
1919
<QuickLink title="kmcp deploy" description="Deploy your MCP server to a Kubernetes cluster." href="/docs/kmcp/reference/kmcp-deploy" />

‎src/config/navigation.json‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -161,24 +161,14 @@
161161
"description": "Find helpful resources, troubleshooting tips, and FAQs for kagent. Access guides, community links, and more.",
162162
"items": [
163163
{
164-
"title": "API Reference",
165-
"href": "/docs/kagent/resources/api",
166-
"description": "Complete API reference documentation for kagent CRDs and resources."
164+
"title": "API docs",
165+
"href": "/docs/kagent/resources/api-ref",
166+
"description": "kagent API reference docs"
167167
},
168168
{
169-
"title": "Helm Charts",
170-
"href": "/docs/kagent/resources/helm/helm",
171-
"description": "Configuration reference for the main kagent Helm chart."
172-
},
173-
{
174-
"title": "CRDs Chart",
175-
"href": "/docs/kagent/resources/helm/crds",
176-
"description": "Configuration reference for the kagent CRDs Helm chart."
177-
},
178-
{
179-
"title": "Troubleshooting",
180-
"href": "/docs/kagent/resources/troubleshooting",
181-
"description": "Find solutions to common issues and troubleshooting tips for kagent."
169+
"title": "Helm Chart Configuration",
170+
"href": "/docs/kagent/resources/helm",
171+
"description": "kagent Helm chart configuration reference"
182172
},
183173
{
184174
"title": "FAQs",
@@ -189,6 +179,11 @@
189179
"title": "Release Notes",
190180
"href": "/docs/kagent/resources/release-notes",
191181
"description": "Review the release notes for kagent."
182+
},
183+
{
184+
"title": "Troubleshooting",
185+
"href": "/docs/kagent/resources/troubleshooting",
186+
"description": "Find solutions to common issues and troubleshooting tips for kagent."
192187
}
193188
]
194189
}
@@ -254,6 +249,11 @@
254249
"href": "/docs/kmcp/reference",
255250
"description": "",
256251
"items": [
252+
{
253+
"title": "API docs",
254+
"href": "/docs/kmcp/reference/api-ref",
255+
"description": "kmcp API reference docs"
256+
},
257257
{
258258
"title": "kmcp add-tool",
259259
"href": "/docs/kmcp/reference/kmcp-add-tool",

0 commit comments

Comments
 (0)