[jira] [Created] (CAMEL-24233) camel-catalog - Include component and EIP documentation (adoc) in the catalog JAR

["Claus Ibsen (Jira)" <ji...@apache.org>]

Claus Ibsen created CAMEL-24233:
-----------------------------------

             Summary: camel-catalog - Include component and EIP documentation (adoc) in the catalog JAR
                 Key: CAMEL-24233
                 URL: https://issues.apache.org/jira/browse/CAMEL-24233
             Project: Camel
          Issue Type: Improvement
            Reporter: Claus Ibsen


The camel-catalog JAR currently contains JSON metadata for components, EIPs, data formats, and languages (options, headers, types, defaults). However, the prose documentation (usage examples, error handling guides, configuration details) from the src/main/docs/*.adoc files is not included.

Including the raw AsciiDoc documentation files in the catalog JAR would make them available to:
- *MCP tools* - AI agents could access full component documentation alongside the JSON metadata
- *CLI/TUI* - The Camel TUI could render documentation directly in the terminal (TamboUI already has a MarkdownView widget, and adoc is structurally similar enough for lightweight rendering)
- *IDE tooling* - Any tool consuming the catalog could offer documentation without needing to fetch from the website

The approach:
- Extend PrepareCatalogMojo to copy the adoc files from each component/EIP/language/dataformat module into the catalog JAR (e.g. under catalog/docs/)
- Strip or skip the include::partial$ directives since those resolve to shared boilerplate and Antora-specific table generators (the option tables are already covered by the JSON metadata)
- The raw adoc prose content is self-contained and readable as-is

Scope: ~712 adoc files, ~7MB total - small enough for a JAR.

Note: The camel-website already converts these to Markdown for the offline documentation bundles (LTS releases only), but having the adoc in the catalog makes it available for every version including SNAPSHOT and non-LTS releases.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)