Jinal-Sarvaiya opened a new pull request, #189:
URL: https://github.com/apache/camel-kit/pull/189
## Description
Fixes #161
This PR adds comprehensive documentation for the Camel YAML DSL guidance
coverage in the architecture page, addressing the follow-up items from #106.
### What's documented:
1. **Coverage by agent** - Describes which agents use which templates and
when rules are loaded:
- Claude Code, Bob 2, Qwen, OpenCode: Use shared template, rules load
immediately on project open
- Antigravity, Codex CLI: Use agent-specific templates, rules load on
project open
- GitHub Copilot CLI: Rules load on first invocation or when instructions
are refreshed
- Pi: Rules load when project context is read, typically on first skill
invocation or when trusted
2. **Link to maintained rule list** - Points to the [canonical rule
source](https://github.com/apache/camel-kit/blob/main/kit/camel-kit-core/src/main/resources/templates/shared/agents-md.md#camel-422-rules)
in `templates/shared/agents-md.md` instead of duplicating content
3. **Schema validation vs. runtime verification** - Explains the critical
distinction:
- Schema validation (`camel validate`): Static check for structure,
types, and placement
- Runtime verification: Requires launching the app, reading logs, and
exercising all endpoints
- Passing schema checks ≠ working integration
## Verification
- [x] Build validation passes: `./mvnw -Psourcecheck validate -B`
- [x] Addresses all three items from issue #161:
- [x] Coverage by agent with loading behavior
- [x] Link to maintained rule list
- [x] Schema validation vs runtime verification distinction
## Notes
- The "development snapshot" wording will change when the release containing
#106 ships
- This documentation applies to the development snapshot (0.4.2-SNAPSHOT)
- The rule list link points to `main` branch for latest rules; consider
using a versioned link when the next release ships
--
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]