Skip to content

Conversation

@vprashar2929
Copy link
Collaborator

No description provided.

@github-actions github-actions bot added the docs Documentation changes label Nov 18, 2025
@vprashar2929 vprashar2929 marked this pull request as ready for review November 20, 2025 11:02
Copy link
Collaborator

@vimalk78 vimalk78 left a 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

Copy link
Collaborator

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

Copy link
Collaborator Author

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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> **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")
Copy link
Collaborator

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

@vprashar2929 vprashar2929 force-pushed the docs-agents branch 2 times, most recently from f56fa45 to 3d9c739 Compare November 27, 2025 08:18
@vprashar2929
Copy link
Collaborator Author

add a section for bundle generation guideline (crd, kustimization, webhook) a section for must-gather? perhaps not

Good suggestion on the bundle generation section - I'll add guidelines covering the CRD → kustomize → bundle workflow
since AI agents often try to edit auto-generated files directly.
For must-gather, I agree it's probably not needed in AGENTS.md. It's already well-documented in must-gather/README.md and is more of a diagnostic tool than a development workflow.

Signed-off-by: vprashar2929 <[email protected]>
@vimalk78 vimalk78 merged commit 62b5bdf into sustainable-computing-io:main Dec 3, 2025
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants