Skip to content

Update docs on AI bundle: clarify GitHub release assets are static, update Quick Start to use container #3268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matthewhelmke merged 2 commits into from
Apr 23, 2026
+10 −9
Merged

Update docs on AI bundle: clarify GitHub release assets are static, update Quick Start to use container #3268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c293fd3
Update docs on AI bundle
matthewhelmke Apr 23, 2026
8a8241e
Change URLs and notes to avoid stale content
matthewhelmke Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions content/ai-docs-security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ Example patterns we redact:

### Direct Download Verification

> **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.

```bash
# 1. Download files
curl -LO https://github.com/chainguard-dev/edu/releases/download/ai-docs-bundle/chainguard-ai-docs.tar.gz
Expand Down
13 changes: 6 additions & 7 deletions content/developer-resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,11 @@ Choose your preferred distribution method:

### GitHub Release

> **Note:** The assets in this release are static and not updated automatically. For current documentation, use the container distribution below.

| Format | Description | Verification |
|--------|-------------|-------------|
| [Latest Release](https://github.com/chainguard-dev/edu/releases/tag/ai-docs-bundle) | Cryptographically signed documentation bundle (~1.7MB) | Includes Cosign signatures and certificates |
| [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 |

### Container Distribution

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

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

### Quick Start

```bash
# Download the documentation bundle from GitHub releases
curl -LO https://github.com/chainguard-dev/edu/releases/download/ai-docs-bundle/chainguard-ai-docs.tar.gz

# Extract the markdown file
tar -xzf chainguard-ai-docs.tar.gz
# Extract current documentation from the container image
docker run --rm -v $(pwd):/output ghcr.io/chainguard-dev/ai-docs:latest extract /output

# The extracted file 'chainguard-ai-docs.md' is ready to use with your AI assistant
```
Expand Down
4 changes: 2 additions & 2 deletions content/mcp-server-ai-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ latest, latest-dev, 3.13, 3.13-dev, ...

## Standalone Installation (without Docker)

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):
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.

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

## Alternative: Static Documentation

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:
If you don't need MCP server functionality, extract the documentation from the container:

```bash
docker run --rm -v $(pwd):/output \
Expand Down