Apache Camel rebuilds its documentation path for developers and AI assistants

Apache Camel has redesigned its website around a dual audience: developers reading the documentation directly and AI coding assistants retrieving it on their behalf. The change is more than a visual refresh. The project has added build-time checks for route examples, machine-readable documentation pages and a more direct path to runnable Camel projects.

A shorter path to a working route

The project’s engineering post says the new front page replaces a generic description of Camel with three concrete starting points: Camel CLI commands, a Spring Boot project and a Quarkus extension. It also presents the same Kafka-to-database route in YAML, Java and XML so readers can compare the supported DSLs without navigating away.

Camel says it chose the page’s terminology for both human scanning and machine retrieval. The page names the project’s 350-plus connectors, Java, YAML and XML DSLs, Spring Boot and Quarkus runtimes, Enterprise Integration Patterns, MCP server and Apache 2.0 license. The project also moved its security, release-cadence and adoption material into a more prominent “Why Camel” path.

Documentation examples become build inputs

The more consequential change is in the documentation pipeline. Camel now runs examples through the same validation used by its CLI and MCP server so a broken example can fail the site build instead of waiting for a reader to discover it.

The first validation pass found 71 incorrect examples among 290 YAML listings on the Enterprise Integration Pattern pages. A second pass found 87 failures across 1,820 YAML route examples on 28 component pages. The project then checked XML against schemas, Java imports against the source tree and property keys against the catalog, correcting more than 100 additional listings. Camel says those corrections are in Camel 4.23 and the build guards will remain in place.

For agent tooling, each documentation page is also available as plain Markdown by replacing .html with .md. Camel’s llms.txt file provides a machine-readable project description and points agents to versioned offline documentation bundles that include catalog metadata and the YAML DSL schema.

What changes for application teams

The practical gain is a tighter feedback loop between framework code and the examples developers or coding agents copy into integrations. Build-validated listings do not guarantee that generated routes are correct for a production system, but they reduce the chance that the project’s own documentation teaches obsolete syntax or invalid configuration.

The redesign keeps existing documentation URLs and RSS feeds unchanged. Camel says restructuring the user manual is next, with the goal of helping newcomers and agents reach the relevant page without first understanding the project’s 19-year history.