kobweb icon indicating copy to clipboard operation
kobweb copied to clipboard

EPIC: Reference MVP

Open bitspittle opened this issue 3 years ago • 0 comments

We need to get Kobweb documented (at https://kobweb.varabyte.com).

Instead of creating a bunch of one off bugs, I've decided to collect everything here, both as it will be easier to update when I realize an item is missing, but also people can view this as a roadmap for what's to come.

Note that there will be a separate bug for guides, which are more about workflows. These issues or for going into detail about specific features.

Kobweb

  • [ ] Installation
  • [ ] Project philosophy
    • [ ] The different layers, e.g. core, silk, gradle plugins, ...
    • [ ] Extending Compose HTML
  • [ ] Project layout
    • [ ] components
    • [ ] pages
    • [ ] resources
      • [ ] public
      • [ ] markdown
    • [ ] conf.yaml
      • [ ] all properties
  • [ ] App / AppGlobals
  • [ ] Page / routeOverride
  • [ ] PackageMapping
  • [ ] PageContext / query parameters / dynamic routes
  • [ ] Link / Router / OpenLinkStrategy
  • [ ] ApiFetcher
  • [ ] Setting the Error page
  • [ ] Route prefix

Silk

  • [ ] Modifier
    • [ ] The difference between Silk Modifiers and Jetpack Compose Modifiers
    • [ ] CSS properties vs subproperties
  • [ ] Theming / Color Mode / StyleVariables / Colors / Shapes
  • [ ] ComponentStyle / ComponentVariant
    • [ ] And the "base" variants
    • [ ] And extra modifiers
    • [ ] When to create a ComponentStyle vs. using inline styles
  • [ ] Breakpoints
  • [ ] InitSilk
  • [ ] ElementScope / ref
  • [ ] Deferred rendering

Silk Components

  • [ ] Surface
  • [ ] Link
  • [ ] Image
  • [ ] Canvas (2d and Gl)
  • [ ] Divider
  • [ ] SimpleGrid
  • [ ] SpanText
    • [ ] SpanText vs Text (e.g. using SpanText in a Column, not Text)
  • [ ] TOC

Markdown

  • [ ] Markdown resources
  • [ ] Configuring markdown output

Kobweb CLI

  • [ ] kobweb list
  • [ ] kobweb create
  • [ ] kobweb export
  • [ ] kobweb run
  • [ ] kobweb stop

bitspittle avatar Feb 21 '22 18:02 bitspittle