⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

Conversation

@oscerd
Copy link
Contributor

@oscerd oscerd commented Jan 15, 2026

…t for adding examples

Description

Add examples support for auto-generated JBang command docs

Adds support for including examples in auto-generated JBang command documentation via separate AsciiDoc files.

The workflow is as follows:

  • Create an examples file at docs/user-manual/modules/ROOT/pages/jbang-commands/examples/{command}.adoc
  • The generator automatically detects and includes it in the generated command page
  • File naming: run.adoc for camel run, catalog-component.adoc for camel catalog component

Target

  • I checked that the commit is targeting the correct branch (Camel 4 uses the main branch)

Tracking

  • If this is a large change, bug fix, or code improvement, I checked there is a JIRA issue filed for the change (usually before you start working on it).

Apache Camel coding standards and style

  • I checked that each commit in the pull request has a meaningful subject line and body.
  • I have run mvn clean install -DskipTests locally from root folder and I have committed all auto-generated changes.

…t for adding examples

Signed-off-by: Andrea Cosentino <[email protected]>
@oscerd
Copy link
Contributor Author

oscerd commented Jan 15, 2026

This is for a first review, but I need to understand the reason for new line in asciidoc

@oscerd oscerd marked this pull request as ready for review January 16, 2026 08:52
@oscerd oscerd requested a review from davsclaus January 16, 2026 08:52
@oscerd oscerd merged commit 721d7d0 into main Jan 16, 2026
5 checks passed
@oscerd oscerd deleted the CAMEL-22861 branch January 16, 2026 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants