Skip to content

Update README.md - #131

Open
Meherzi Zied (Zied031) wants to merge 1 commit into
microsoft:masterfrom
Zied031:patch-1
Open

Update README.md#131
Meherzi Zied (Zied031) wants to merge 1 commit into
microsoft:masterfrom
Zied031:patch-1

Conversation

@Zied031

Copy link
Copy Markdown

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.

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.

@ManyaS-Git Manya Sharma (ManyaS-Git) left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants