webcomponents / webcomponents/custom-elements-manifest

More documentation and examples

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

Description

Can we please get some more documentation besides a schema and the super basic example in the README?

For example maybe

- further examples in the examples folder would help,
- for example an example of a complex custom element that covers all of the use cases,
- including all the `Type`s of usual attributes an element can have (number, string, boolean, etc), events (including `onfoo` properties, event types, etc),
- maybe examples of more complex types like `Array` in a recommended format (like a reference implementation) that people should try to follow
- How to generate CEM
- etc

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the schema, the basic README example, and the existing examples folder mentioned in the issue. Identify the current CEM generation guidance and decide which example cases are missing, including complex custom elements, attribute types, events, and complex types. Done means the requested documentation and representative examples are added with a clear recommended format.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, web-dev
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.