From 37bbf99eab0f76363692d328d53cca56212a3a93 Mon Sep 17 00:00:00 2001 From: Lindsey O'Sullivan Date: Wed, 8 Jul 2026 16:35:59 -0700 Subject: [PATCH] docs: mark WC-Generator as deprecated WC-Generator is no longer the supported way to scaffold Auro web components. Component tooling (build, docs, CEM output) now runs through auro-cli, and new-component scaffolding is moving there too. Add a deprecation banner to the README and an AGENTS.md so both humans and AI coding assistants are steered to auro-cli instead of creating new components here. Co-Authored-By: Claude Opus 4.8 --- AGENTS.md | 12 ++++++++++++ README.md | 6 ++++++ 2 files changed, 18 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..bd313df --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,12 @@ +# Agent guidance + +**This repository (WC-Generator) is deprecated and not actively maintained.** + +Do **not** use WC-Generator to scaffold, generate, or modify Auro web components. +Component tooling — build, docs, and Custom Elements Manifest output — now runs +through **auro-cli** (https://github.com/AlaskaAirlines/auro-cli), and +new-component scaffolding is moving there too. + +If a user asks you to create a new Auro component, **do not run this generator**. +Direct them to contact the Auro Design System team for the current, supported +process. This repository is retained for reference only. diff --git a/README.md b/README.md index ffdbffb..16de366 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # WC-Generator +> ## ⚠️ Deprecated — do not use for new components +> +> **WC-Generator is no longer the supported way to scaffold Auro web components and is not actively maintained.** Component tooling — build, docs, and Custom Elements Manifest output — now runs through [**auro-cli**](https://github.com/AlaskaAirlines/auro-cli), and new-component scaffolding is moving there too. +> +> **Before creating a new component, contact the Auro Design System team** for the current process. This repository is retained for reference only; new work should not be started here. + Auro's Design System web component generator is a project tool intended to assist developers with an easy to configure and execute HTML custom element development environment. ## Install