Documentation List

[AngelMunoz]

I think good documentation will always attract devs, so here's a list of things that we could start tracking (feel free to add more) with the documentation

For that I think we can grab inspiration of Vue Guide, Lit docs, and imba docs

Vue is really good at explaining the whole in/outs of their framework and Lit is quite concise and short, it lacks some of the extended approach of vue, but I think a middle ground for Sutil could be really good

Introduction

• What is Sutil - WIP
• Getting Started - WIP
  • Dotnet templates
  • GH templates (useful for exploration not just getting started) - WIP
• Why/Why not use it

Concepts

• Syntax
• Lists - WIP
• Forms - WIP
• Classes/Styles - WIP
• Simple binds - WIP
• Events - WIP

In-Depth

• Styling
• Life Cycle
• Events
• Binding
• Stores
• Rendering
• Custom Events
• Web Component Interop

Transitions - Animations

(I'm not really familar with this so if you can put something here it would be good)

Advanced (perhaps not the best word)

• Browser Requirements

• Testing

• Integration with other parts of the stack

  • SAFE
  • ASP.NET

• Using Bundlers

  • Webpack
  • Snowpack (I can take this one)
  • Vite? (I think Alfonso was experimenting with this a few months ago)
  • Parcel?

• Deployment

  • Github Pages
  • Firebase (I can take this one)

There are a couple of those that already exist or can be adapted from the current examples

[AngelMunoz]

This was added in the F# slack when a discussion around documentation came by https://documentation.divio.com/ it actually fits well with what I had in mind, the website style is irrelevant the content is the good one, it's a documentation website that helps you know how to write documentation it's worth taking it a look