docs: add prerequisites section to README #1179
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 <141008634+Kelpejol@users.noreply.github.com>
Kelpejol
requested review from
EItanya,
ilackarms,
peterj and
yuval-k
as code owners
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 paulkayode2018@gmail.com