Skip to content

Update Functionality Overview in README #40275

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 4, 2025
Merged

Update Functionality Overview in README #40275

merged 1 commit into from
Jul 4, 2025

Conversation

xmulligan
Copy link
Member

Follow up from #38993 as a rewrite of the section

Update Functionality Overview in README

@xmulligan xmulligan requested a review from a team as a code owner June 30, 2025 10:35
@xmulligan xmulligan requested a review from qmonnet June 30, 2025 10:35
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Jun 30, 2025
@xmulligan xmulligan added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. labels Jun 30, 2025
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Jun 30, 2025
@xmulligan
Copy link
Member Author

Here is the Google doc https://docs.google.com/document/d/11G8sNTjPbcXCxNqvNIKGdd0f0lYWeUNxweJEX5Z7qLQ/edit?tab=t.0#heading=h.4n6w6nk42ss0

@xmulligan
Copy link
Member Author

/test

xmulligan
xmulligan commented Jun 30, 2025
View reviewed changes
xmulligan
xmulligan commented Jun 30, 2025
View reviewed changes
qmonnet
qmonnet approved these changes Jun 30, 2025
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

A few formatting nits, but looks great otherwise!

qmonnet
qmonnet requested changes Jun 30, 2025
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

(Sorry I meant to request change, to have at least the broken link fixed)

I also note that the spell checker in CI complains about unknown words.

xmulligan
xmulligan commented Jun 30, 2025
View reviewed changes
xmulligan
xmulligan commented Jun 30, 2025
View reviewed changes
@xmulligan
Copy link
Member Author

I've added the words to the spelling list

qmonnet
qmonnet requested changes Jun 30, 2025
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Thanks, but there are still some formatting issues 🙂

Please squash your commits together, as well.

xmulligan
xmulligan commented Jun 30, 2025
View reviewed changes
@xmulligan xmulligan force-pushed the functionality-overview branch from b734138 to 3d9d26f Compare June 30, 2025 15:28
@xmulligan xmulligan requested a review from joestringer July 2, 2025 14:50
joestringer
joestringer approved these changes Jul 2, 2025
View reviewed changes
Copy link
Member

@joestringer joestringer left a comment

Choose a reason for hiding this comment

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

Couple of minor comments but otherwise looks good. Thanks @xmulligan !

qmonnet
qmonnet approved these changes Jul 2, 2025
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Thanks!

xmulligan
xmulligan commented Jul 3, 2025
View reviewed changes
xmulligan
xmulligan commented Jul 3, 2025
View reviewed changes
@xmulligan
Copy link
Member Author

Added two suggestions to address your comments, let me know what you think

@joestringer
Copy link
Member

Both changes LGTM.

@xmulligan
Update Functionality Overview in README
1ed2631 
Follow up from #38993 as a rewrite of the section

Signed-off-by: Bill Mulligan <billmulligan516@gmail.com>
@xmulligan xmulligan force-pushed the functionality-overview branch from 6c172e9 to 1ed2631 Compare July 3, 2025 20:49
@xmulligan xmulligan enabled auto-merge July 3, 2025 20:50
@xmulligan
Copy link
Member Author

/test

@xmulligan xmulligan disabled auto-merge July 4, 2025 08:22
@qmonnet qmonnet added dont-merge/discussion A discussion is ongoing and should be resolved before merging, regardless of reviews & tests status. and removed dont-merge/discussion A discussion is ongoing and should be resolved before merging, regardless of reviews & tests status. labels Jul 4, 2025
@qmonnet qmonnet closed this Jul 4, 2025
@qmonnet qmonnet reopened this Jul 4, 2025
@qmonnet
Copy link
Member

qmonnet commented Jul 4, 2025

/test

@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jul 4, 2025
@xmulligan xmulligan added this pull request to the merge queue Jul 4, 2025
Merged via the queue into main with commit 1568306 Jul 4, 2025
120 of 121 checks passed
@xmulligan xmulligan deleted the functionality-overview branch July 4, 2025 11:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joestringer joestringer joestringer approved these changes

@qmonnet qmonnet qmonnet approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@xmulligan @joestringer @qmonnet