-
Notifications
You must be signed in to change notification settings - Fork 28
docs: add README for agents #643
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add README for agents #643
Conversation
1f6ab25 to
7d44547
Compare
vimalk78
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add a section for bundle generation guideline (crd, kustimization, webhook)
a section for must-gather? perhaps not
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR adds AGENTS.md but PR title is for docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
its a doc right 😅
AGENTS.md
Outdated
|
|
||
| # AGENTS.md | ||
|
|
||
| > **AI Agent Guide for Kepler Operator** - Essential information for AI coding assistants (GitHub Copilot, Claude, ChatGPT) contributing to this project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| > **AI Agent Guide for Kepler Operator** - Essential information for AI coding assistants (GitHub Copilot, Claude, ChatGPT) contributing to this project. | |
| > **AI Agent Guide for Kepler Operator** - Essential information for AI coding assistants (GitHub Copilot, Claude, Codex) contributing to this project. |
AGENTS.md
Outdated
| - Different Helm chart versions between README and installation guides | ||
| - Outdated command examples that no longer work | ||
| - Missing updates to Table of Contents when adding sections | ||
| - Inconsistent terminology (e.g., "PowerMonitor" vs "power-monitor") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
better to mention what to use
f56fa45 to
3d9c739
Compare
Good suggestion on the bundle generation section - I'll add guidelines covering the CRD → kustomize → bundle workflow |
Signed-off-by: vprashar2929 <[email protected]>
3d9c739 to
31eee32
Compare
No description provided.