CAMEL-23702: Make jbang exported project more AI-relevant#24063
Open
k-krawczyk wants to merge 1 commit into
Open
CAMEL-23702: Make jbang exported project more AI-relevant#24063k-krawczyk wants to merge 1 commit into
k-krawczyk wants to merge 1 commit into
Conversation
Enhance the project generated by the Camel CLI export so that AI coding assistants get useful context out of the box. - Add a "For AI coding assistants" section to the generated readme.md (both JVM and Quarkus native templates) pointing at the Apache Camel LLM index (https://camel.apache.org/llms.txt), the .html->.md Markdown trick, and the Camel CLI / MCP server for looking up components. - Generate an AGENTS.md file at the exported project root with project-specific guidance for coding agents (new agents.md.ftl template, written by Export#copyAgents for all runtimes including Quarkus). - Extend TemplateHelperTest and ExportTest accordingly.
Contributor
Author
|
cc @orpiske (reporter) @Croway @davsclaus for review — this generates an Reported by Claude Code on behalf of Karol Krawczyk |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CAMEL-23702
The project generated by the Camel CLI (
camel export) provided little context for users bootstrapping with coding assistants, which increases effort and the chance of hallucinations.Changes
readme.md(both the JVMreadme.md.ftland the Quarkus nativereadme.native.md.ftltemplates). It points at:.htmlwith.md,agents.md.ftltemplate and generate anAGENTS.mdfile at the exported project root (Export#copyAgents, invoked for all runtimes including the Quarkus override). It gives coding agents a concise "start here", project layout, and build/run guidance.Testing
mvn test -pl dsl/camel-jbang/camel-jbang-core:TemplateHelperTest(24) — templates render with no unresolved interpolations and contain the llms.txt link; newtestAgentsTemplate.ExportTest#shouldGenerateContent/shouldGenerateJavaContent(6) —AGENTS.mdis generated for Camel Main, Spring Boot and Quarkus exports.Relates to CAMEL-23701 (archetypes) and CAMEL-23700 (website agents.md / llms.txt).
Reported by Claude Code on behalf of Karol Krawczyk