Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation on some core stuff #22

Open
dead-claudia opened this issue Aug 28, 2018 · 3 comments
Open

Missing documentation on some core stuff #22

dead-claudia opened this issue Aug 28, 2018 · 3 comments
Assignees

Comments

@dead-claudia
Copy link
Member

dead-claudia commented Aug 28, 2018

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.
@dead-claudia
Copy link
Member Author

@MithrilJS/collaborators I can't be the only one noticing patterns here with common questions. I plan to drop this by the Mithril Gitter, too, to see if I can get some more things to potentially add. I'm pretty sure we could get a pretty decently sized page of various frequently asked questions in various areas.

@dead-claudia dead-claudia changed the title Add a FAQ page Missing documentation on some core stuff Sep 1, 2018
@dead-claudia
Copy link
Member Author

BTW, I recast the main issue, since I've decided against adding a FAQ page. Just letting you all know.

@dead-claudia
Copy link
Member Author

Related (and basically a better-thought-out dupe of my original idea): MithrilJS/mithril.js#2262

@dead-claudia dead-claudia self-assigned this Sep 2, 2024
@dead-claudia dead-claudia transferred this issue from MithrilJS/mithril.js Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Low priority
Development

No branches or pull requests

1 participant