jamesnetherton commented on code in PR #601: URL: https://github.com/apache/camel-quarkus-examples/pull/601#discussion_r4255433376
########## README.adoc: ########## @@ -1,5 +1,7 @@ = Apache Camel Quarkus Examples +For AI coding agents: see https://camel.apache.org/llms.txt[llms.txt] for Apache Camel and the https://camel.apache.org/camel-quarkus/latest/[Camel Quarkus documentation] for the extensions. Pages on both are also available as Markdown by replacing `.html` with `.md` in the URL (for example, https://camel.apache.org/camel-quarkus/latest/reference/extensions/kafka.md). The https://camel.apache.org/manual/camel-jbang-mcp.html[Camel MCP server] looks up components and their options and validates routes. Review Comment: Could this move out of the opening paragraph into its own section, placed after the "Useful links" list? As it stands it is the first thing human readers see when they land on the repo. The Apache Camel README does this with a dedicated [`## AI integration`](https://github.com/apache/camel/blob/main/README.md#ai-integration) section, and it would be good to stay consistent with it. Something like: ```adoc == AI integration AI coding assistants can read the documentation as Markdown: https://camel.apache.org/llms.txt[llms.txt] indexes the Apache Camel documentation, and the https://camel.apache.org/camel-quarkus/latest/[Camel Quarkus documentation] covers the extensions. Pages on both are also available as Markdown by replacing `.html` with `.md` in the URL (for example, https://camel.apache.org/camel-quarkus/latest/reference/extensions/kafka.md). The https://camel.apache.org/manual/camel-jbang-mcp.html[Camel MCP server] looks up components and their options and validates routes. ``` _Claude Code on behalf of James Netherton_ -- 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]
