search

webtides / element-js

Simple and lightweight base classes for web components with a beautiful API
MIT License
28 stars 3 forks source link

Feature/add initial docs #7

Closed eddyloewen closed 4 years ago

eddyloewen commented 4 years ago

This is the initial draft for the documentation. It would be nice if you could read over it and:

  1. tell me what you think
  2. tell me if something is missing
  3. tell me if something is wrong
  4. tell me if something could be described better

You can either check out the branch and edit it yourself or comment here in the PR and I will gladly update die PR.

Here is the link to de docs with the rendered markdown: https://github.com/webtides/element-js/tree/feature/add-initial-docs/docs

quarkus commented 4 years ago

@eddyloewen I think one of the first sentences should focus on element-js NOT being another framework. Just a simple Layer of abstraction between the dev and the platform.

eddyloewen commented 4 years ago

I tried to update and resolve everything from the comments. We're still far away from a complete documentation but I think I would like to leave it as is for now and move on to other things.

Maybe this is a good starting point and we can start to improve small parts of the docs whenever we change/add/fix something.

I will try to write some more documentation for setting up a new stack/project and how to bundle things when I will add element-js to the next project.

If everyone is cool with that ( @quarkus @lukas-schardt @KinG-DE ) I would like to merge this now.