webcomponents / webcomponents/custom-elements-manifest

Add recommended JSDoc tags

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

Description

Many analysis tools will use JSDoc tags to determine what web component specific features. To keep from fragmenting the ecosystem around different sets of JSDoc, we should make a recommended set of tags.

Tags will need to document the features in the CustomElement schema kind:

- Tag Name
- Attributes
- Events
- Slots
- CSS Shadow Parts
- CSS Custom Properties
- Demos

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the CustomElement schema kind and compare its documented features with existing JSDoc conventions. Define a recommended tag set covering tag names, attributes, events, slots, CSS shadow parts, CSS custom properties, and demos; the issue names no files or tests, so completion requires agreement on the specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, web-dev
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.