[
https://issues.apache.org/jira/browse/CAMEL-23701?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18103005#comment-18103005
]
Karol Krawczyk commented on CAMEL-23701:
----------------------------------------
PR: https://github.com/apache/camel/pull/25409
Same approach as CAMEL-23702, applied to the Maven archetypes:
- ReadMe.txt renamed to README.md in all six archetypes, content rewritten in
Markdown, documentation links refreshed to https and to the current
camel.apache.org/manual/writing-components.html location.
- Every generated project now also gets an AGENTS.md: the Apache Camel LLM
index (https://camel.apache.org/llms.txt), the .html -> .md documentation
trick, a pointer to the Camel CLI and the Camel MCP server with an explicit "do
not invent component URIs or options" instruction, plus the project layout, the
build/run commands and the conventions of that archetype.
- The six archetype-metadata.xml file sets were updated, since the readme is
listed there explicitly and the rename alone would have silently dropped it.
- Upgrade guide entry added for 4.22.
[~orpiske] could you review it, since you reported this one?
_Reported by Claude Code on behalf of Karol Krawczyk_
> camel-ai: Camel archetypes should be adjusted for greater AI relevance
> -----------------------------------------------------------------------
>
> Key: CAMEL-23701
> URL: https://issues.apache.org/jira/browse/CAMEL-23701
> Project: Camel
> Issue Type: Improvement
> Components: camel-ai, camel-archetypes
> Affects Versions: 4.x
> Reporter: Otavio Rodolfo Piske
> Priority: Major
> Labels: easy-fix, help-wanted
>
> One problem with our current archetypes is that the generated project doesn't
> provide much assistance out of the box for users bootstrapping new projects.
> This typically leads to generated projects that may require greater effort
> for users leveraging coding assistants and also increase the chance of those
> assistants hallucinating.
>
> We should apply the following changes:
> * Rename ReadMe.txt to README.md
> * Adjust the contents of the readme file to provide greater insights for
> coding agents to:
> ** Provide better contextual information about the project template
> ** Reducing the required tokens
> * (Optional) Include an AGENTS.md file with additional context
>
> At the very least, we should make sure that the README.md file contains a
> link to [https://camel.apache.org/llms.txt] so that coding agents know from
> where to start.
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
