Skip to content

Commit 759658f

Browse files
Update docs on AI bundle: clarify GitHub release assets are static, update Quick Start to use container (#3268)
## Summary - Adds a note to the GitHub Release section warning that release assets are static and not automatically updated - Renames the release link from "Latest Release" to "Archived Bundle" to avoid implying freshness - Replaces the Quick Start curl command (which downloads from the frozen release) with the docker run ... extract command, which pulls from the live container image Preview: https://deploy-preview-3268--ornate-narwhal-088216.netlify.app/developer-resources/#download-options ## Context The ai-docs-bundle GitHub Release is covered by an org ruleset that makes release assets immutable. The workflow attempts to update them on each build but fails silently (the step has continue-on-error: true), meaning users who download from the release get stale documentation. The container (ghcr.io/chainguard-dev/ai-docs:latest) is updated correctly on each build and is the right path for current docs. This PR updates the page to reflect that reality while a longer-term fix for the release update workflow is investigated.
1 parent 2558170 commit 759658f

3 files changed

Lines changed: 10 additions & 9 deletions

File tree

content/ai-docs-security.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ Example patterns we redact:
8888

8989
### Direct Download Verification
9090

91+
> **Note:** The assets in this release are static and not updated automatically. These verification steps apply to the archived snapshot. For current documentation, use the container distribution.
92+
9193
```bash
9294
# 1. Download files
9395
curl -LO https://github.com/chainguard-dev/edu/releases/download/ai-docs-bundle/chainguard-ai-docs.tar.gz

content/developer-resources.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,11 @@ Choose your preferred distribution method:
4242

4343
### GitHub Release
4444

45+
> **Note:** The assets in this release are static and not updated automatically. For current documentation, use the container distribution below.
46+
4547
| Format | Description | Verification |
4648
|--------|-------------|-------------|
47-
| [Latest Release](https://github.com/chainguard-dev/edu/releases/tag/ai-docs-bundle) | Cryptographically signed documentation bundle (~1.7MB) | Includes Cosign signatures and certificates |
49+
| [Archived Bundle](https://github.com/chainguard-dev/edu/releases/tag/ai-docs-bundle) | Static documentation bundle snapshot with Cosign signatures | Includes Cosign signatures and certificates |
4850

4951
### Container Distribution
5052

@@ -119,18 +121,15 @@ Add to your `claude_desktop_config.json`:
119121
- Searchable and queryable documentation
120122
- Perfect for automated workflows
121123
- Works with Claude Desktop, Cursor, and other MCP-compatible tools
122-
- Also available as a [standalone Python script](https://github.com/chainguard-dev/edu/releases/tag/ai-docs-bundle) (no Docker required)
124+
- Also available as a [standalone Python script (static snapshot)](https://github.com/chainguard-dev/edu/releases/tag/ai-docs-bundle) (no Docker required)
123125

124126
[**Full MCP Server Documentation →**](/mcp-server-ai-docs/)
125127

126128
### Quick Start
127129

128130
```bash
129-
# Download the documentation bundle from GitHub releases
130-
curl -LO https://github.com/chainguard-dev/edu/releases/download/ai-docs-bundle/chainguard-ai-docs.tar.gz
131-
132-
# Extract the markdown file
133-
tar -xzf chainguard-ai-docs.tar.gz
131+
# Extract current documentation from the container image
132+
docker run --rm -v $(pwd):/output ghcr.io/chainguard-dev/ai-docs:latest extract /output
134133

135134
# The extracted file 'chainguard-ai-docs.md' is ready to use with your AI assistant
136135
```

content/mcp-server-ai-docs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ latest, latest-dev, 3.13, 3.13-dev, ...
242242

243243
## Standalone Installation (without Docker)
244244

245-
The MCP server is also available as a standalone Python script from the [GitHub release](https://github.com/chainguard-dev/edu/releases/tag/ai-docs-bundle):
245+
The MCP server is also available as a standalone Python script. These files are static snapshots from the [archived GitHub release](https://github.com/chainguard-dev/edu/releases/tag/ai-docs-bundle) and are not automatically updated. For current documentation, use the container distribution above.
246246

247247
```bash
248248
# Download the MCP server, requirements, docs, and catalog
@@ -311,7 +311,7 @@ Then configure your MCP client to connect to `http://localhost:8080/mcp/`.
311311

312312
## Alternative: Static Documentation
313313

314-
If you don't need MCP server functionality, you can download the documentation as a single markdown file from the [GitHub release](https://github.com/chainguard-dev/edu/releases/tag/ai-docs-bundle), or extract it from the container:
314+
If you don't need MCP server functionality, extract the documentation from the container:
315315

316316
```bash
317317
docker run --rm -v $(pwd):/output \

0 commit comments

Comments
 (0)