webcomponents / webcomponents/custom-elements-manifest

What to do with "demo"?

Open
#23 7 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
502
Forks
27
PR merge metrics
No merged PRs in 30d

Description

Demo is an interesting bit of the schema. Right now it's only referenced from `CustomElement#demos`, but really, anything could have an associated demo, including or especially the package as a whole.

We could add a `demos` field to all declarations, modules and package. We could also add an extensible `metadata` field to just about everything and make `DemoMetadata` well-known object that can appear there.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue only points to CustomElement#demos and offers two competing schema directions: demos on more entities or extensible metadata with DemoMetadata. Start by reviewing the existing schema around CustomElement#demos; no files or tests are named, and done requires a decided direction plus a clearly specified schema change.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.