Fix: Add soft deperecation notice for the ButtonGroup component

[hbhalodia]

What?

Issue - #65338

Why?

• Since we are moving to ToggleGroupControl, so need to deprecate the ButtonGroup as no more needed.
• See - Replace ButtonGroup usage with ToggleGroupControl #65339

How?

• PR add the @deprecate on JS Doc.
• PR updates the README and story book to feature as deprecated.

Testing Instructions

1. Use ButtonGroup component, it should show the warning in console with deprecation message.

Testing Instructions for Keyboard

• NIL

Screenshots or screencast

[github-actions]

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

• Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
• Labels found: [Status] Blocked.

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: hbhalodia <[email protected]>
Co-authored-by: ciampo <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[ciampo]

Let's wait before reviewing / merging this one until all usages of ButtonGroup have been removed in the repo.