Extend documentation #13

New Issue

2020-06-03T15:42:04Z

phryk commented

2020-06-03 15:42:04 +00:00

(Migrated from rnd.phryk.net)

Things that should have proper inline docs

Renderable
Storable
Permission
Protected
Administerable
Comment
Commentable
Tag
Taggable
Form
SVG
[Ephemeral]Dataset
- Has to explain structure of EphemeralDataset.layers and typecasting logic!
[Ephemeral]Geodata

Things that need extra articles with further explanations and/or advanced patterns

theming
- point out scss integration
- explain directory structure
- explain theme file override order/mechanism
- explain jinja inheritance
tagging
- explain hierarchies and what they're good for
form
- bind -> validate -> process flow
- point out Fieldset support and ProxyFieldset
- give an overview on how to construct complex Forms a la DataEditor
debugging
- pudb integration
- profiling integration

#### Things that should have proper inline docs #### - `Renderable` - `Storable` - `Permission` - `Protected` - `Administerable` - `Comment` - `Commentable` - `Tag` - `Taggable` - `Form` - `SVG` - `[Ephemeral]Dataset` - Has to explain structure of `EphemeralDataset.layers` and typecasting logic! - `[Ephemeral]Geodata` #### Things that need extra articles with further explanations and/or advanced patterns #### - theming - point out scss integration - explain directory structure - explain theme file override order/mechanism - explain jinja inheritance - `tagging` - explain hierarchies and what they're good for - `form` - `bind` -> `validate` -> `process` flow - point out `Fieldset` support and `ProxyFieldset` - give an overview on how to construct complex `Form`s a la `DataEditor` - debugging - pudb integration - profiling integration

Sign in to join this conversation.