DEPRECATION: add deprecation warning to this package

[DukeFerdinand]

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

Summary by Sourcery

Deprecate the current component by adding a warning in the README.md and updating the documentation generation process to reflect the deprecation status.

Enhancements:

• Add a deprecation warning to the README.md file indicating that the component is deprecated and users should migrate to the new Auro Formkit.

Build:

• Update the build script to use a new deprecatedDocsProcessor.js script for generating documentation.

Documentation:

• Add a new README.md template in the docTemplates directory to standardize documentation for deprecated components.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a deprecation warning to the package by updating documentation and build scripts. It modifies the README to indicate deprecation, updates the stylesheet link, and changes the documentation build script to use a new processor. Additionally, it adds a new template for generating deprecated documentation and a script to process these templates.

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

File-Level Changes

Change	Details	Files
Added deprecation warning to the README file.	Updated the title to indicate deprecation. Added a warning message advising users to migrate to the new Auro Formkit.	README.md
Updated the stylesheet link in the README.	Changed the stylesheet link to point to the 'auro-classic' path.	README.md
Modified the build script for documentation generation.	Replaced the existing documentation build script with a new script for processing deprecated documentation.	package.json
Added a new template for generating deprecated documentation.	Created a new README template for deprecated components.	docTemplates/README.md
Introduced a new script for processing deprecated documentation templates.	Implemented a script to process documentation files using the new template.	packageScripts/deprecatedDocsProcessor.js

---

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 note in the README about the new location or repository for the Auro Formkit to guide users on where to find the updated component.
• Ensure that the deprecatedDocsProcessor.js script is thoroughly tested to handle all edge cases, as it is now responsible for generating the documentation.

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

[sourcery-ai]

issue (typo): Repeated 'the' in sentence.

There's a repeated 'the' in the sentence 'each time the the docs are compiled.' It should be corrected to 'each time the docs are compiled.'

Suggested change

	and copied to `./componentDocs/README.md` each time the the docs are compiled.
	and copied to `./componentDocs/README.md` each time the docs are compiled.

[blackfalcon]

🎉 This PR is included in version 4.3.2 🎉

The release is available on:

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

Your semantic-release bot 📦🚀