Skip to content

Commit 25368c1

Browse files
davsclausclaude
andcommitted
CAMEL-23788: document zip directory structure in llms.txt for AI agents
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent de4ee2c commit 25368c1

2 files changed

Lines changed: 18 additions & 6 deletions

File tree

.github/workflows/offline-bundle.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ jobs:
5454
TITLE="Apache Camel ${{ inputs.camel_version }} — Offline Documentation"
5555
NOTES="Offline documentation bundle for Apache Camel ${{ inputs.camel_version }}.
5656
57-
Contains all Markdown documentation for connectors/components (350+) and the user manual, plus the Camel Catalog (JSON metadata for all components, data formats, languages) and the YAML DSL canonical JSON Schema.
57+
Contains 350+ connector/component docs (Markdown), the user manual, the Camel Catalog (JSON metadata for all connectors/components, data formats, languages, and EIPs), and the YAML DSL canonical JSON Schema.
5858
5959
Download and unzip locally for AI coding agents or environments with restricted internet access."
6060

llms-txt-template.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,23 @@ For agents or environments with no or restricted internet access, versioned offl
1313
- [Camel 4.18](https://github.com/apache/camel-website/releases/download/docs-4.18/camel-docs-4.18.zip)
1414
- [Camel 4.14](https://github.com/apache/camel-website/releases/download/docs-4.14/camel-docs-4.14.zip)
1515

16-
Download the zip matching your Camel version, unzip it locally, and read the files from there. Each bundle includes:
17-
- All connectors/components documentation (350+ as Markdown)
18-
- The user manual (Markdown)
19-
- The Camel Catalog — machine-readable JSON metadata for every component, data format, language, and EIP (parameters, types, defaults, descriptions)
20-
- The YAML DSL canonical JSON Schema — the definitive spec for validating and generating Camel YAML routes (`catalog/schema/camelYamlDsl-canonical.json`)
16+
Download the zip matching your Camel version, unzip it locally, and read the files from there. Each bundle contains:
17+
18+
```
19+
components/<version>/ — 350+ connector/component docs (Markdown)
20+
manual/ — user manual (Markdown)
21+
catalog/
22+
components/ — 350+ connector/component metadata (JSON)
23+
dataformats/ — data format metadata (JSON)
24+
languages/ — expression language metadata (JSON)
25+
models/ — EIP model metadata (JSON)
26+
others/ — other component metadata (JSON)
27+
schema/
28+
camelYamlDsl-canonical.json — YAML DSL JSON Schema
29+
llms.txt — this file
30+
```
31+
32+
The `catalog/` JSON files contain machine-readable metadata for every connector/component, data format, language, and EIP — parameters, types, defaults, and descriptions. The YAML DSL schema is the definitive spec for validating and generating Camel YAML routes.
2133

2234
## Key facts
2335

0 commit comments

Comments
 (0)