Skip to content

Missing documentation on some core stuff #22

@dead-claudia

Description

@dead-claudia

Edit: Not suggesting adding a FAQ page anymore, so I recast the issue. I've preserved the previous text in case you're curious what it was previously.

Old proposal I'm collecting things for a potential FAQ page. I've got a few already, but I know there's got to be more between here and Gitter. This would include both TS-related and core Mithril-related stuff, so we have an easy, always-up-to-date page on commonly asked questions here.

There's a couple things I've found that need documented, and I'm pretty sure there's more that also need added.

  • Anti-pattern: Classes as component factories = bad: Object.create used in initComponent messes up state mithril.js#1926
  • What vnode.state is in various places, including in the various component types as well as in the vnode attrs themselves.
  • We need to show people how to install the typings and show them where to report typings issues. This hasn't shown up in the GH issues much, but many people have asked on Gitter where they are. It's not exactly obvious from the mithril.js.org website that we generally support them as a community-maintained thing, and I think we should fix that.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

Low priority

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions