docs: add prerequisites section to README #1179
Conversation
Adds prerequisites section aligned with Quick Start guide to help new users understand required tools before starting. This surfaces the prerequisites from our documentation directly in the README, reducing friction for first-time users. Signed-off-by: Kelpejol <[email protected]>
Kelpejol
requested review from
EItanya,
ilackarms,
peterj and
yuval-k
as code owners
EItanya
left a comment
EItanya
left a comment
There was a problem hiding this comment.
Hey there, thanks so much for the contribution! I'm not so sure the main README.me is the best place for this. It makes it seems like kind and openai are necessary for using kagent, but that's not really true, they're just necessary for running it locally. Maybe there's a way we can more easily link to local getting started docs, or potentially locate this further down the README. What do you think?
|
Thanks so much for the feedback, You're absolutely right - I see how this could be confusing. 🙏 I think the best approach would be to relocate this section to align better with the local development flow. How about: Option 1: Move it under a "Local Development Quickstart" heading further down in the README Option 2: Replace it with a simple link like:
Which approach would you prefer? Or if you have another suggestion, I'm happy to implement that! 😊 we using kagent to build great things, would love to contribute |
2 participants
Description
Adds a prerequisites section to the main README that aligns with the Quick Start documentation, making it easier for new users to understand what they need before getting started.
Motivation
As a new contributor, Currently, users must navigate to the documentation site to learn what tools they need. This change surfaces those requirements directly in the README, reducing friction for new users while keeping the content focused and aligned with our Quick Start guide.
Changes
Related Documentation
This aligns with our Quick Start guide
Type of Change
Checklist
Signed-off-by: Paul Olukayode [email protected]