WIP docs

some of this stuff is briefly mentioned in https://github.com/leeoniya/domvm#templates and easily overlooked, other stuff requires reading the code of the demos, and the rest is just plain missing. i think the list below represents a fairly thorough todo list for the docs.

does anyone have a good feel for how best to prioritize the items in terms of greatest impact?

cc @lawrence-dol @iamjohnlong @sabine @tropperstyle @e1ectronic @xz64

General:

• port patterns https://github.com/leeoniya/domvm/wiki/View-Model-Patterns
• high-level API table to complement the dense templates rundown, à la https://github.com/leeoniya/domvm/issues/147#issuecomment-307530884
• stream adapters/reactivity, domvm.prop()
• walk through a third-party router integration, couple simple examples of third-party lib interop
• immutability, (as diff optimizations)
• vnodes are immutable https://github.com/leeoniya/domvm/issues/165#issuecomment-314411305
• provide answer for lack of ES6 class-views & how to get similar inheritance via Object.assign()

[leeoniya]

I think the title of “What’s Missing?” wrongly implies that DOMVM is deficient. I think that section should be included in the intro, under a sub-title like “What DOMVM Is Not”, or something similar that denotes scope-restriction rather than functional lack.

👍

“Into” should be “Introduction”

👍

Also, the documentation index should, I think, be immediately after the Introduction

eh. domvm is meant for a technical audience. personally, i always want examples first and docs second, only if the examples already “felt right”. the index is an entire extra screen of scrolling.

[leeoniya]

It seems to me that these are corresponding actions and should use the same names (Insert and Remove).

Yeah, maybe a bit.

However, i like that they’re distinctively-named since they have different args and vms have corresponding vm.mount() and vm.unmount() methods that can be invoked directly, whereas vnodes do not. It would likely help with tracking down user bug reports since i dont have to ask for clarification about which willInsert hook they’re talking about, especially if there are simultaneously both vm-level and node-level hooks in the same view.