-
Notifications
You must be signed in to change notification settings - Fork 219
docs: add README for agents #2356
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
base: main
Are you sure you want to change the base?
docs: add README for agents #2356
Conversation
| ``` | ||
|
|
||
| ### CI Checks | ||
|
|
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.
will agents.md work for ci check?
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.
yes
SamYuan1990
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.
I am not sure if this agents.md too large.
can it reference to existing document?
c8ab803 to
f121e73
Compare
Updated the markdown |
|
@vimalk78 @KaiyiLiu1234 Should we also create symlink for CLAUDE.md as well? |
|
Looks good to me. |
f121e73 to
7e30c98
Compare
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]>
7e30c98 to
c7fab5d
Compare
| make deps | ||
|
|
||
| # Build the project | ||
| make build |
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.
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?
Add consolidated quick reference guide for AI agents contributing to
Kepler. Includes the development setup, testing instructions, PR
guidelines and project-specific context.