Update README.md - #131
Open
Meherzi Zied (Zied031) wants to merge 1 commit into
Open
Conversation
I added a short "New User Note" at the top of the README to guide beginners on how to navigate and start using the repository effectively.
Manya Sharma (ManyaS-Git)
approved these changes
Aug 12, 2026
Manya Sharma (ManyaS-Git)
left a comment
There was a problem hiding this comment.
Good, minimal change — approved.
I verified the note's claims against the current README.md on master and they all check out:
- "Getting Started" section exists below (TOC +
# Getting Started <a name="Getting-Started">), so "start by exploring the 'Getting Started' section below" is accurate. - AI100 - Samples, AI200 - Reference Architectures, and AI300 - Best Practices all exist as sections, so the recommendation to start with AI100 before AI200/AI300 matches the actual structure.
Nice touches:
- It's a
>blockquote, so it reads as a callout rather than competing with the existing intro paragraph. - It doesn't touch any of the existing content or links — no merge conflicts, no regressions.
One optional suggestion (not blocking): instead of referring to the sections by name, you could link them directly, e.g. [**"Getting Started"**](#getting-started) and [**AI100 - Samples**](#ai100), so the note is immediately clickable for newcomers. That would make it fully self-contained navigation.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I added a short "New User Note" at the top of the README to guide beginners on how to navigate and start using the repository effectively.