Skip to content

docs: mark WC-Generator as deprecated#637

Merged
jason-capsule42 merged 1 commit into
AlaskaAirlines:masterfrom
lindseyo1123:feat/publish-cem-manifest
Jul 9, 2026
Merged

docs: mark WC-Generator as deprecated#637
jason-capsule42 merged 1 commit into
AlaskaAirlines:masterfrom
lindseyo1123:feat/publish-cem-manifest

Conversation

@lindseyo1123

@lindseyo1123 lindseyo1123 commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Repurposed: this PR previously added Custom Elements Manifest generation to the component template. That work is now redundant — component CEM output already runs through auro-cli's docs pipeline (the dev branch runs the custom-elements-manifest analyzer + cem-sorter). WC-Generator itself is no longer the supported way to scaffold Auro components.

This PR now marks WC-Generator as deprecated so both humans and AI coding assistants stop using it for new components.

Changes

  • README.md — deprecation banner at the top: not the supported scaffolding path, not actively maintained, contact the Auro team before creating a new component.
  • AGENTS.md (new, repo root) — instructs AI coding assistants (Claude, Cursor, Copilot) not to use this generator for new components and to route users to the Auro team.

Why not archive?

The team has decided not to archive the repo yet, so a README banner + AGENTS.md is the deprecation signal. No replacement command is named intentionally — component build/CEM already run through auro-cli, but the scaffold replacement (auro generate) is still in progress and not released, so pointing users at it would be premature.

Notes

  • Docs-only change; the banner sits outside any AURO-GENERATED-CONTENT block so build:docs won't overwrite it.
  • Banner/AGENTS.md live at repo root, not in template/, so they are not copied into scaffolded components.

🤖 Generated with Claude Code

@lindseyo1123
lindseyo1123 requested a review from a team as a code owner July 7, 2026 23:12

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @lindseyo1123, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@lindseyo1123
lindseyo1123 force-pushed the feat/publish-cem-manifest branch from ad23919 to b853c6e Compare July 8, 2026 23:39
@lindseyo1123 lindseyo1123 changed the title build(template): generate and publish Custom Elements Manifest docs: mark WC-Generator as deprecated Jul 8, 2026
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 <noreply@anthropic.com>
@lindseyo1123
lindseyo1123 force-pushed the feat/publish-cem-manifest branch from b853c6e to 37bbf99 Compare July 8, 2026 23:50
@jason-capsule42
jason-capsule42 merged commit ba408dc into AlaskaAirlines:master Jul 9, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants