Rework docs, guides, CONTRIBUTING...

[hsablonniere]

Reuse experience from onboarding @BlackYoup and @urcadox to improve the docs...

[hsablonniere]

@antleblanc I onboarded two colleagues on this and I have some ideas but if you have suggestions, please share :wink:

[antleblanc]

It depends of the expectations you have.

From Storybook you can keep the Storybook Docs addon.

I've recently experiment VuePress as a static site generator for some documentations and it was enjoyable, well documented and easy to start with.

Otherwise I would recommend the following awesome list:

• https://github.com/myles/awesome-static-generators#documentation

Bonus: I'm currently watching at VitePress (VuePress' little brother) which is in Work In Progress.

[hsablonniere]

@antleblanc Thanks but I was just refering to the content, we'll keep the current storybook + md files in repo.

[hsablonniere]

This new contributing docs need to describe our "Storybook Driven Development" process. We'll split it in different entry files:

• setup the project (clone, config, run dev..., where to find stuffs)
• designing the component (data inputs, event outputs, wording, wireframe...)
• setup the component and its story
• document the component's I/O and description with JSDoc
• dev the component
  • how lit works
  • rules (sort order, getter/setter, reflect, attributes...)
  • inlined ifs
  • skeleton pattern
  • i18n
  • CSS
  • rules about <h1>, <p> tags
  • default display
  • ...
• review
  • about the GitLab CI setup
  • what to review
  • automatic stuffs (eslint, check-i18n, check-lit)
• publication
  • build system
  • release process with npm
  • (CDN build & publication)

[hsablonniere]

from @BlackYoup It would be better to have the "how to run storybook" in the README.