DEPRECATION: add deprecation warning to this package

[DukeFerdinand]

Resolves AlaskaAirlines/auro-formkit#394, adding deprecation warning to old form element repositories.

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Checklist:

• My update follows the CONTRIBUTING guidelines of this project
• I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

Summary by Sourcery

Adds a deprecation warning to the auro-radio component and updates documentation to reflect this change. Migrates documentation to point to the new Auro Formkit.

Chores:

• Deprecate auro-radio component.
• Migrate documentation to point to the new Auro Formkit.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds a deprecation warning to the auro-radio component, updates documentation generation scripts, and adjusts file paths to ensure proper documentation for the deprecated component.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Adds a deprecation warning to the component.	Adds a warning message at the top of the README to indicate the component is deprecated and users should migrate to Auro Formkit.	README.md
Updates file paths for documentation generation.	Updates the WC-Generator link in README.md to use README_updated_paths.md. Updates file paths in demo/api.md, demo/index.md, README.md, and docs/partials/index.md to point to the docs/partials directory. Updates file paths in docs/partials/api.md to point to the ../apiExamples directory.	demo/api.md docs/partials/api.md demo/index.md README.md docs/partials/index.md
Updates package scripts and dependencies.	Updates @aurodesignsystem/auro-library dependency to version ~3.0.2. Replaces the build:docs script with a custom script deprecatedDocsProcessor.js. Updates the postversion script to include build:api and build:docs.	package.json
Adds a custom documentation processor.	Adds a new file packageScripts/deprecatedDocsProcessor.js to handle documentation generation for deprecated components. This script defines file configurations for processing README.md, index.md, and api.md files. It uses @aurodesignsystem/auro-library utilities for file processing and template filling.	packageScripts/deprecatedDocsProcessor.js
Adds a template for the README file.	Adds a new file docTemplates/README.md to serve as a template for generating the README.md file. This template includes a deprecation warning and placeholders for component descriptions, use cases, and other information.	docTemplates/README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[github-actions]

Surge demo deployment failed! 😭

[sourcery-ai]

Hey @DukeFerdinand - I've reviewed your changes - here's some feedback:

Overall Comments:

• This PR introduces a deprecation warning, which is great for informing users about the component's status.
• Consider adding a link to the new Auro Formkit in the deprecation warning for easy migration.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}