Otavio Rodolfo Piske created CAMEL-23701:
--------------------------------------------
Summary: 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
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)
