This is an automated email from the ASF dual-hosted git repository. luigidemasi pushed a commit to branch docs/antora-scaffold in repository https://gitbox.apache.org/repos/asf/camel-kit.git
commit c6b62816352c7400d9bbb2f52b1ef4706391cc46 Author: Luigi De Masi <[email protected]> AuthorDate: Thu Oct 22 14:22:31 2026 +0200 docs: add Antora scaffold for camel.apache.org Add the Antora component layout that lets the Apache Camel website build the Camel Kit documentation from this repository: docs/antora.yml (component camel-kit, version next, prerelease), the navigation, the overview page and one stub per navigation entry so every xref resolves. The stubs are filled by the following documentation pull requests; the existing docs/*.md files are not changed. Built locally with the Camel website UI bundle at log failure level warn: 27 pages, no warnings. --- docs/antora.yml | 30 +++++ docs/modules/ROOT/nav.adoc | 31 +++++ docs/modules/ROOT/pages/agents.adoc | 3 + docs/modules/ROOT/pages/architecture.adoc | 3 + docs/modules/ROOT/pages/camel-brainstorm.adoc | 3 + docs/modules/ROOT/pages/camel-debug.adoc | 3 + docs/modules/ROOT/pages/camel-execute.adoc | 3 + docs/modules/ROOT/pages/camel-plan.adoc | 3 + docs/modules/ROOT/pages/camel-start.adoc | 3 + docs/modules/ROOT/pages/camel-validate.adoc | 3 + docs/modules/ROOT/pages/commands.adoc | 3 + docs/modules/ROOT/pages/constitution.adoc | 3 + docs/modules/ROOT/pages/contributing.adoc | 3 + docs/modules/ROOT/pages/eitl.adoc | 3 + docs/modules/ROOT/pages/forage.adoc | 3 + docs/modules/ROOT/pages/getting-started.adoc | 3 + docs/modules/ROOT/pages/graph.adoc | 3 + docs/modules/ROOT/pages/greenfield.adoc | 3 + docs/modules/ROOT/pages/index.adoc | 130 +++++++++++++++++++++ docs/modules/ROOT/pages/knowledge.adoc | 3 + docs/modules/ROOT/pages/mcp.adoc | 3 + docs/modules/ROOT/pages/migration-biztalk.adoc | 3 + .../ROOT/pages/migration-camel-upgrade.adoc | 3 + docs/modules/ROOT/pages/migration-mulesoft.adoc | 3 + docs/modules/ROOT/pages/migration.adoc | 3 + docs/modules/ROOT/pages/pipeline.adoc | 3 + docs/modules/ROOT/pages/ship.adoc | 3 + docs/modules/ROOT/pages/skills.adoc | 3 + docs/modules/ROOT/pages/verification.adoc | 3 + 29 files changed, 269 insertions(+) diff --git a/docs/antora.yml b/docs/antora.yml new file mode 100644 index 00000000..6e92f56d --- /dev/null +++ b/docs/antora.yml @@ -0,0 +1,30 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: camel-kit +title: Camel Kit +version: next +prerelease: true +display-version: Next (Pre-release) +nav: +- modules/ROOT/nav.adoc +asciidoc: + attributes: + # Keep in step with distribution.properties and the README release channels + camel-kit-version: 0.4.1 + camel-kit-knowledge-version: 0.0.2 + camel-version: 4.22.1 diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc new file mode 100644 index 00000000..f79dbc52 --- /dev/null +++ b/docs/modules/ROOT/nav.adoc @@ -0,0 +1,31 @@ +* xref:index.adoc[Camel Kit] +* Getting started +** xref:getting-started.adoc[Install and first project] +** xref:agents.adoc[Supported AI agents] +** xref:greenfield.adoc[Greenfield workflow] +** xref:migration.adoc[Migration workflow] +*** xref:migration-mulesoft.adoc[MuleSoft] +*** xref:migration-biztalk.adoc[BizTalk] +*** xref:migration-camel-upgrade.adoc[Camel 2.x and 3.x] +* Pipeline +** xref:pipeline.adoc[Stages, approval gate and Iron Laws] +** xref:camel-start.adoc[camel-start] +** xref:camel-brainstorm.adoc[camel-brainstorm] +** xref:camel-plan.adoc[camel-plan] +** xref:camel-execute.adoc[camel-execute] +** xref:camel-validate.adoc[camel-validate] +** xref:verification.adoc[Runtime verification] +** xref:camel-debug.adoc[camel-debug] +** xref:ship.adoc[Ship workflow (Technology Preview)] +* Architecture +** xref:architecture.adoc[Architecture overview] +** xref:skills.adoc[Skills system] +** xref:mcp.adoc[MCP servers] +** xref:knowledge.adoc[Knowledge MCP] +** xref:graph.adoc[Graph intelligence] +** xref:eitl.adoc[Environment-in-the-loop] +** xref:forage.adoc[Forage configuration catalog] +* Reference +** xref:commands.adoc[Command reference] +** xref:constitution.adoc[Constitution] +* xref:contributing.adoc[Contributing and releasing] diff --git a/docs/modules/ROOT/pages/agents.adoc b/docs/modules/ROOT/pages/agents.adoc new file mode 100644 index 00000000..5db2c3ea --- /dev/null +++ b/docs/modules/ROOT/pages/agents.adoc @@ -0,0 +1,3 @@ += Supported AI agents + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/architecture.adoc b/docs/modules/ROOT/pages/architecture.adoc new file mode 100644 index 00000000..51bd3a8d --- /dev/null +++ b/docs/modules/ROOT/pages/architecture.adoc @@ -0,0 +1,3 @@ += Architecture overview + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/camel-brainstorm.adoc b/docs/modules/ROOT/pages/camel-brainstorm.adoc new file mode 100644 index 00000000..f1194ea9 --- /dev/null +++ b/docs/modules/ROOT/pages/camel-brainstorm.adoc @@ -0,0 +1,3 @@ += camel-brainstorm + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/camel-debug.adoc b/docs/modules/ROOT/pages/camel-debug.adoc new file mode 100644 index 00000000..24a128e1 --- /dev/null +++ b/docs/modules/ROOT/pages/camel-debug.adoc @@ -0,0 +1,3 @@ += camel-debug + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/camel-execute.adoc b/docs/modules/ROOT/pages/camel-execute.adoc new file mode 100644 index 00000000..a8a19b26 --- /dev/null +++ b/docs/modules/ROOT/pages/camel-execute.adoc @@ -0,0 +1,3 @@ += camel-execute + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/camel-plan.adoc b/docs/modules/ROOT/pages/camel-plan.adoc new file mode 100644 index 00000000..291dea94 --- /dev/null +++ b/docs/modules/ROOT/pages/camel-plan.adoc @@ -0,0 +1,3 @@ += camel-plan + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/camel-start.adoc b/docs/modules/ROOT/pages/camel-start.adoc new file mode 100644 index 00000000..fe81cf1b --- /dev/null +++ b/docs/modules/ROOT/pages/camel-start.adoc @@ -0,0 +1,3 @@ += camel-start + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/camel-validate.adoc b/docs/modules/ROOT/pages/camel-validate.adoc new file mode 100644 index 00000000..f65938ae --- /dev/null +++ b/docs/modules/ROOT/pages/camel-validate.adoc @@ -0,0 +1,3 @@ += camel-validate + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/commands.adoc b/docs/modules/ROOT/pages/commands.adoc new file mode 100644 index 00000000..54eab002 --- /dev/null +++ b/docs/modules/ROOT/pages/commands.adoc @@ -0,0 +1,3 @@ += Command reference + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/constitution.adoc b/docs/modules/ROOT/pages/constitution.adoc new file mode 100644 index 00000000..79ad150c --- /dev/null +++ b/docs/modules/ROOT/pages/constitution.adoc @@ -0,0 +1,3 @@ += Constitution + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/contributing.adoc b/docs/modules/ROOT/pages/contributing.adoc new file mode 100644 index 00000000..cece1109 --- /dev/null +++ b/docs/modules/ROOT/pages/contributing.adoc @@ -0,0 +1,3 @@ += Contributing and releasing + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/eitl.adoc b/docs/modules/ROOT/pages/eitl.adoc new file mode 100644 index 00000000..13383c95 --- /dev/null +++ b/docs/modules/ROOT/pages/eitl.adoc @@ -0,0 +1,3 @@ += Environment-in-the-loop + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/forage.adoc b/docs/modules/ROOT/pages/forage.adoc new file mode 100644 index 00000000..a837d487 --- /dev/null +++ b/docs/modules/ROOT/pages/forage.adoc @@ -0,0 +1,3 @@ += Forage configuration catalog + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/getting-started.adoc b/docs/modules/ROOT/pages/getting-started.adoc new file mode 100644 index 00000000..8ed5fc35 --- /dev/null +++ b/docs/modules/ROOT/pages/getting-started.adoc @@ -0,0 +1,3 @@ += Install and first project + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/graph.adoc b/docs/modules/ROOT/pages/graph.adoc new file mode 100644 index 00000000..3c889539 --- /dev/null +++ b/docs/modules/ROOT/pages/graph.adoc @@ -0,0 +1,3 @@ += Graph intelligence + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/greenfield.adoc b/docs/modules/ROOT/pages/greenfield.adoc new file mode 100644 index 00000000..e7ea3f3f --- /dev/null +++ b/docs/modules/ROOT/pages/greenfield.adoc @@ -0,0 +1,3 @@ += Greenfield workflow + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc new file mode 100644 index 00000000..d5de218f --- /dev/null +++ b/docs/modules/ROOT/pages/index.adoc @@ -0,0 +1,130 @@ += Camel Kit + +Camel Kit adds structured workflows for Apache Camel integration development to AI coding assistants. +It guides an assistant through the integration lifecycle: requirements and design, planning, implementation, +testing, and runtime verification, and it checks every component and option against the Camel catalog while it +does so. It is available as a standalone command-line tool and as a Camel JBang plugin, and it generates the same +skills for several coding agents. + +This documentation describes Camel Kit {camel-kit-version} with Knowledge MCP {camel-kit-knowledge-version}, +which target Camel {camel-version}. + +== What it does + +* *AI-guided design.* Slash commands run a structured interview and produce a versionable design specification. +* *Platform migration.* Detects the source platform and converts MuleSoft 3.x and 4.x, Microsoft BizTalk, + Camel 2.x and 3.x, and JBoss Fuse projects to Camel 4 with YAML DSL routes. +* *Catalog verification over MCP.* Components, endpoint options and infrastructure `forage.*` keys are verified + against the Camel catalog and the Forage catalog at design and review time. +* *Graph intelligence.* Nine parsers and two post-processors build a dependency-injection-aware property graph of + the codebase for analysis and migration context. +* *Runtime verification.* Build, startup and test checks run in the real environment; failures are classified, + fixed within a bounded retry budget, and reported. +* *Several AI agents.* The same skills are generated for eight coding agents (see <<agents>>). + +== The workflow + +---- +Entry: /camel-start routes migration, planning, execution, validation, + debugging or greenfield work based on context + +Greenfield: /camel-brainstorm -> /camel-plan -> /camel-execute -> /camel-validate + |- implements (camel-implement) + |- verifies (camel-verify, internal) + '- tests (camel-test) + +Migration: /camel-migrate -> /camel-plan -> /camel-execute -> /camel-validate + +Utilities: /camel-ship Technology Preview: delegates to the local Ship controller + /camel-knowledge documentation Q&A + /camel-debug standalone troubleshooting +---- + +[cols="1,3"] +|=== +| Command | Purpose + +| `/camel-start` +| Entry point. Routes migration sources to migrate, approved designs to plan, ready plans to execute, generated + routes to validate, broken projects outside a pipeline to debug, and other work to brainstorm. + +| `/camel-brainstorm` +| Interactive design session that produces business requirements and a design specification. + +| `/camel-migrate` +| Migration from MuleSoft, Microsoft BizTalk, legacy Camel or JBoss Fuse to Camel 4. + +| `/camel-plan` +| Reviews the approved design and creates an implementation plan with wave analysis for parallel execution. + +| `/camel-execute` +| Orchestrated execution: probes the environment, implements tasks in dependency waves, runs adversarial, spec and + quality reviews, and performs the applicable smoke and runtime verification. + +| `/camel-validate` +| Final static quality gate, or a standalone project check: schema, endpoints, quality, security, anti-patterns and + constitution compliance, without modifying routes. + +| `/camel-debug` +| Standalone troubleshooting outside a pipeline for broken routes, build failures, startup errors and runtime + exceptions. + +| `/camel-ship` +| Technology Preview. Thin entry point for the local Ship controller, which owns the end-to-end run with + configurable oversight (`always`, `smart`, `never`). + +| `/camel-knowledge` +| Documentation Q&A: semantic search over the Camel documentation, CVE advisories, release notes and the component + catalog. +|=== + +See xref:pipeline.adoc[] for the stages, the approval gate and the Iron Laws, and xref:commands.adoc[] for every +option. + +[[agents]] +== Supported AI agents + +`camel-kit init --ai <target>` generates the project layout for one agent. Each row is an alternative layout, not +one combined tree. All targets share the same Markdown skills, adapted through agent-specific traits and native +configuration. + +[cols="1,1,2,1"] +|=== +| Agent | Init flag | Primary generated assets | MCP configuration + +| Anthropic Claude Code | `--ai claude` | `CLAUDE.md`, `.claude/commands/`, `.claude/skills/` | `.mcp.json` +| IBM Bob 2 (default) | `--ai bob2` | `.bob/custom_modes.yaml`, rules, `.bob/skills/`, `.bob/agents/`, `.bob/personas/` | `.bob/mcp.json` +| Google Antigravity | `--ai antigravity` | `AGENTS.md`, `.agents/skills/`, `.agents/agents/`, `.agents/camel-kit-personas/` | `.agents/mcp_config.json` +| OpenAI Codex CLI | `--ai codex` | `AGENTS.md`, `.agents/skills/`, `.codex/agents/` | `.codex/config.toml` +| GitHub Copilot CLI | `--ai copilot` | `.github/copilot-instructions.md`, `.github/agents/`, `.github/skills/` | `.github/mcp.json` +| Pi | `--ai pi` | `AGENTS.md`, `.pi/skills/`, `.pi/prompts/`, guard extension and policy | `.mcp.json` via `pi-mcp-adapter` +| Qwen | `--ai qwen` | `QWEN.md`, `.qwen/commands/`, `.qwen/skills/`, `.qwen/agents/`, `.qwen/camel-kit-personas/` | `.qwen/settings.json` +| OpenCode | `--ai opencode` | `AGENTS.md`, `.opencode/commands/`, `.opencode/skills/`, `.opencode/agents/`, `.opencode/camel-kit-personas/` | `opencode.json` +|=== + +See xref:agents.adoc[] for per-agent setup notes. + +== How it is built + +Camel Kit has four layers: + +. *Agent instructions.* A generated `AGENTS.md` (or the agent's equivalent) routes requests to the right skill; + this is the cross-agent equalization layer. +. *Skills.* Composable Markdown instructions, loaded progressively: metadata first, the skill when triggered, + shared guides only when referenced. +. *MCP servers.* Catalog verification, Citrus test guidance and documentation search, queried on demand instead + of loading catalogs into the agent's context. +. *Graph CLI.* Optional code intelligence for analysis and migration. + +In the agent-run workflow the prompt is the product: generated instructions own the integration behaviour, and the +compiled CLI supplies initialization, configuration, helper commands and the graph. The Ship workflow is the +deliberate exception: its controller (stages, run state, oversight, evidence, guarded publication) is compiled code, +and `/camel-ship` only delegates to it. See xref:architecture.adoc[]. + +== Where to go next + +* xref:getting-started.adoc[] installs the standalone CLI or the Camel JBang plugin and creates a first project. +* xref:greenfield.adoc[] and xref:migration.adoc[] walk through the two workflows end to end. +* xref:ship.adoc[] describes the Technology Preview controller-owned workflow. +* Source code and issue tracker: https://github.com/apache/camel-kit[apache/camel-kit]. + Workflow examples and migration samples: https://github.com/luigidemasi/camel-kit-examples[camel-kit-examples]. diff --git a/docs/modules/ROOT/pages/knowledge.adoc b/docs/modules/ROOT/pages/knowledge.adoc new file mode 100644 index 00000000..a3eff503 --- /dev/null +++ b/docs/modules/ROOT/pages/knowledge.adoc @@ -0,0 +1,3 @@ += Knowledge MCP + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/mcp.adoc b/docs/modules/ROOT/pages/mcp.adoc new file mode 100644 index 00000000..7e7dc9f8 --- /dev/null +++ b/docs/modules/ROOT/pages/mcp.adoc @@ -0,0 +1,3 @@ += MCP servers + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/migration-biztalk.adoc b/docs/modules/ROOT/pages/migration-biztalk.adoc new file mode 100644 index 00000000..0c3634c0 --- /dev/null +++ b/docs/modules/ROOT/pages/migration-biztalk.adoc @@ -0,0 +1,3 @@ += BizTalk migration + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/migration-camel-upgrade.adoc b/docs/modules/ROOT/pages/migration-camel-upgrade.adoc new file mode 100644 index 00000000..379726d0 --- /dev/null +++ b/docs/modules/ROOT/pages/migration-camel-upgrade.adoc @@ -0,0 +1,3 @@ += Camel 2.x and 3.x upgrade + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/migration-mulesoft.adoc b/docs/modules/ROOT/pages/migration-mulesoft.adoc new file mode 100644 index 00000000..c91608de --- /dev/null +++ b/docs/modules/ROOT/pages/migration-mulesoft.adoc @@ -0,0 +1,3 @@ += MuleSoft migration + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/migration.adoc b/docs/modules/ROOT/pages/migration.adoc new file mode 100644 index 00000000..97b0ef10 --- /dev/null +++ b/docs/modules/ROOT/pages/migration.adoc @@ -0,0 +1,3 @@ += Migration workflow + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/pipeline.adoc b/docs/modules/ROOT/pages/pipeline.adoc new file mode 100644 index 00000000..c0798ab2 --- /dev/null +++ b/docs/modules/ROOT/pages/pipeline.adoc @@ -0,0 +1,3 @@ += Pipeline: stages, approval gate and Iron Laws + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/ship.adoc b/docs/modules/ROOT/pages/ship.adoc new file mode 100644 index 00000000..1090623c --- /dev/null +++ b/docs/modules/ROOT/pages/ship.adoc @@ -0,0 +1,3 @@ += Ship workflow (Technology Preview) + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/skills.adoc b/docs/modules/ROOT/pages/skills.adoc new file mode 100644 index 00000000..6238f529 --- /dev/null +++ b/docs/modules/ROOT/pages/skills.adoc @@ -0,0 +1,3 @@ += Skills system + +This page is written in a following documentation pull request. diff --git a/docs/modules/ROOT/pages/verification.adoc b/docs/modules/ROOT/pages/verification.adoc new file mode 100644 index 00000000..258e7087 --- /dev/null +++ b/docs/modules/ROOT/pages/verification.adoc @@ -0,0 +1,3 @@ += Runtime verification + +This page is written in a following documentation pull request.
