Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write user documentation for merged web component repo #6

Open
pkalita-lbl opened this issue Dec 20, 2024 · 0 comments
Open

Write user documentation for merged web component repo #6

pkalita-lbl opened this issue Dec 20, 2024 · 0 comments

Comments

@pkalita-lbl
Copy link
Collaborator

This task is to write end-user documentation for our web components. The Stencil-generated component documentation is great and we should leverage as much as possible, but it doesn't necessarily cover obtaining via a CDN (like unpgk.com) or installing via NPM, registering custom elements, and basic component usage. Some examples on using advanced component features like shadow parts, overriding custom CSS properties, calling methods, and listening for even could also be included.

If there is a simple path to getting the Stencil-generated and hand-authored Markdown content into a format that can be published to GitHub Pages, that might be a nice win. But if it's not simple, we could save that for a separate task.

@pkalita-lbl pkalita-lbl converted this from a draft issue Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant