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

As a web component developer, I want to have a detailed documentation on how to create and prepare a component for publication #189

Open
10 tasks done
Piiit opened this issue Jul 4, 2022 · 0 comments
Assignees

Comments

@Piiit
Copy link
Contributor

Piiit commented Jul 4, 2022

At the moment we have this situation:

The first is just two bulletpoints with not enough information to understand what it is all about, the second is a mix of target audiences, and the last is just for local development.

We need a document, that describes for external developers which requirements exist to have a web component at the end that can be published on the store. This involves two perspectives, the one of the developer, source code structure and needed files, and the second of the final workflow how developers can get in contact with us, and what we need from them to publish their work.

Finally, we need to connect the boilerplate README with the new documentation and vice-versa. I would remove the getting-started page and just link it to our wiki page. Otherwise we might have outdated documentation soon, or two documents that are nearly the same but hardly in-sync.

We have now a list of documentation under:

Creted a hello-world webcomp and merged into the boilerplate + modified the readMe

You can find all the videos in vimeo here : https://vimeo.com/showcase/9687028

Webcomponents videos:

  • use a webcomp in a website
  • intro
  • start with the boilerplate
  • manifest file
  • js file
  • webpack
  • docker
  • publish
  • complete guide

Final task:

  • put everything on the web components website
@Piiit Piiit assigned Piiit and dulvui Jul 4, 2022
@Piiit Piiit assigned d3liaa and dulvui and unassigned Piiit and dulvui Jul 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants