Skip to content

Conversation

@vprashar2929
Copy link
Collaborator

@vprashar2929 vprashar2929 commented Nov 17, 2025

Add consolidated quick reference guide for AI agents contributing to
Kepler. Includes the development setup, testing instructions, PR
guidelines and project-specific context.

@github-actions github-actions bot added the docs Documentation changes label Nov 17, 2025
@vprashar2929 vprashar2929 marked this pull request as draft November 17, 2025 12:44
```

### CI Checks

Copy link
Collaborator

Choose a reason for hiding this comment

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

will agents.md work for ci check?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yes

Copy link
Collaborator

@SamYuan1990 SamYuan1990 left a comment

Choose a reason for hiding this comment

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

I am not sure if this agents.md too large.
can it reference to existing document?

@vprashar2929
Copy link
Collaborator Author

I am not sure if this agents.md too large. can it reference to existing document?

Updated the markdown

@vprashar2929 vprashar2929 marked this pull request as ready for review November 18, 2025 07:10
@vprashar2929
Copy link
Collaborator Author

@vimalk78 @KaiyiLiu1234 Should we also create symlink for CLAUDE.md as well?

@sunya-ch
Copy link
Collaborator

Looks good to me.
@vprashar2929 Can we add the instruction to ensure the content here and the one in docs/user such as https://github.com/sustainable-computing-io/kepler/blob/main/docs/user/installation.md#prerequisites (it seems not match now btw).

@vprashar2929
Copy link
Collaborator Author

Looks good to me. @vprashar2929 Can we add the instruction to ensure the content here and the one in docs/user such as https://github.com/sustainable-computing-io/kepler/blob/main/docs/user/installation.md#prerequisites (it seems not match now btw).

Good catch! You're absolutely right. I have updated AGENTS.md to maintain documentation consistency across all files to prevent this in the future.

Add consolidated quick reference guide for AI agents contributing to
Kepler. Includes the development setup, testing instructions, PR
guidelines and project-specific context.

Signed-off-by: vprashar2929 <[email protected]>
make deps

# Build the project
make build
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you also mention how to run it in more detail (reference to Other installation methods and Quick Start with helm ). Also, what about the documentation for running the dev setup with docker compose?

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.

4 participants