DEPRECATION: add deprecation warning to this package

[DukeFerdinand]

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

Summary by Sourcery

Adds a deprecation warning to the component and updates the documentation to reflect this change. The component now informs users that it is no longer supported and recommends migrating to the new Auro Formkit.

Chores:

• Deprecate the component and add a warning message.
• Update documentation to indicate component deprecation and suggest migration to Auro Formkit.
• Update the build process to use a custom script for generating documentation for deprecated components.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds a deprecation warning to the auro-checkbox component. It updates the README file to include the warning, modifies the build process to use a deprecated documentation generator, and adds a new template for generating deprecated README files.

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 README file.	Adds a warning message indicating that the component is deprecated. Recommends migrating to the new Auro Formkit.	README.md
Updates the build process for documentation.	Replaces the original documentation generation script with a deprecated version. This change ensures that the deprecation warning is included in the generated documentation.	package.json packageScripts/deprecatedDocsProcessor.js
Adds a new template for generating deprecated README files.	Creates a new template file for generating README files for deprecated components. This template includes a deprecation warning and a link to the new Auro Formkit.	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:

• Consider adding a timestamp or version to the deprecation warning to give users a better sense of how long the component has been deprecated.

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.}

[blackfalcon]

🎉 This PR is included in version 4.1.4 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀