davsclaus opened a new issue, #9318:
URL: https://github.com/apache/camel-quarkus/issues/9318

   People, and the coding agents they use, often come straight to 
[camel-quarkus-examples](https://github.com/apache/camel-quarkus-examples) to 
look at working examples instead of starting on the website. That repository 
has issues turned off and its README sends reports here. Nothing there tells an 
agent where the documentation for agents is:
   
   - The README links neither https://camel.apache.org/llms.txt nor the [Camel 
MCP server](https://camel.apache.org/manual/camel-jbang-mcp.html).
   - `AGENTS.md` is a guide for contributing examples 
([CAMEL-23823](https://issues.apache.org/jira/browse/CAMEL-23823)).
   
   Proposal:
   
   1. **README:** a line near the top for coding agents: 
https://camel.apache.org/llms.txt for Camel itself and 
https://camel.apache.org/camel-quarkus/latest/ for the extensions. Pages on 
both are also available as Markdown (replace `.html` with `.md`, for example 
https://camel.apache.org/camel-quarkus/latest/reference/extensions/kafka.md). 
The Camel MCP server looks up components and their options and validates routes.
   2. **AGENTS.md:** a short section at the top for agents that build an 
application from these examples, with the same advice as the `AGENTS.md` that 
`camel export` and the Camel Maven archetypes generate 
([template](https://github.com/apache/camel/blob/main/dsl/camel-jbang/camel-jbang-core/src/main/resources/templates/agents.md.ftl)),
 plus the Camel Quarkus docs. The rest of the file stays the contributor guide.
   
   llms.txt links only two Camel Quarkus pages today, so the pointer should 
name the Camel Quarkus docs directly. GitHub's About sidebar holds only one 
link (the website), so the README is where the pointer has to go. 
apache/camel#27743 does the same for the apache/camel README.
   
   _Claude Code on behalf of davsclaus_
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to