Skip to content

CAMEL-23788: Generate versioned offline documentation bundles#1667

Merged
davsclaus merged 7 commits into
mainfrom
feature/versioned-offline-docs-bundle
Jun 18, 2026
Merged

CAMEL-23788: Generate versioned offline documentation bundles#1667
davsclaus merged 7 commits into
mainfrom
feature/versioned-offline-docs-bundle

Conversation

@davsclaus

Copy link
Copy Markdown
Contributor

Summary

  • Add a manually-triggered GitHub Actions workflow (workflow_dispatch) to generate versioned offline documentation bundles
  • New scripts/generate-offline-bundle.js zips version-specific .md files (components, Spring Boot starters, Kamelets, manual) into a single archive
  • Upload the zip as a GitHub Release asset (e.g. camel-docs-4.18.zip under release tag docs-4.18)
  • Update llms-txt-template.md to list available versioned bundles so AI agents can discover the right version

Motivation

Companies may restrict their AI coding agents from accessing the internet. A versioned offline bundle lets an agent working with Camel 4.14 download just the 4.14 docs, without needing to reach camel.apache.org.

How it works

  1. After a Camel release, a maintainer triggers the workflow from the Actions tab with the version (e.g. 4.18)
  2. The workflow builds the full site, then runs the bundle script to zip only version-specific .md files
  3. The zip is uploaded as a GitHub Release asset — no binary files in the git repo
  4. Normal website builds are unaffected — the zips live in GitHub Releases, not in the published site

Test plan

  • Trigger the workflow manually with a version (e.g. 4.18)
  • Verify the GitHub Release is created with the correct zip
  • Verify the zip contains the expected .md files preserving directory structure
  • Verify llms.txt renders correctly with the new section

🤖 Generated with Claude Code

@davsclaus

Copy link
Copy Markdown
Contributor Author

We should include Quarkus docs as well. And it should also be non LTS releases so when we release 4.21.0 we can have this also.

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Preview is available at

@davsclaus

Copy link
Copy Markdown
Contributor Author

@Croway @oscerd @orpiske - here is an idea to make a offline zip that can make Camel useful for end users with restricted internet access.

To be released and hosted on github

@orpiske

orpiske commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Oh, nice to pack it with a github actions!

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Preview is available at

davsclaus and others added 7 commits June 18, 2026 11:58
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@davsclaus davsclaus force-pushed the feature/versioned-offline-docs-bundle branch from 539b7a4 to 5d82668 Compare June 18, 2026 09:58
@davsclaus davsclaus merged commit 32b61f8 into main Jun 18, 2026
2 checks passed
@davsclaus davsclaus deleted the feature/versioned-offline-docs-bundle branch June 18, 2026 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants