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

Improve docs examples: simple to complex #903

Closed
treshugart opened this issue Nov 3, 2016 · 7 comments
Closed

Improve docs examples: simple to complex #903

treshugart opened this issue Nov 3, 2016 · 7 comments

Comments

@treshugart
Copy link
Member

A comment on hacker news pointed out that the docs should start out a little bit simpler and go to more complex. Currently, there's a couple examples but they are very similar. Coming from web components and seeing Skate, one might not know what render() means right off the bat and may need some explanation. While we don't want to detract those coming from a React (i.e. render() world, examples starting simple and employing some of the spec'd stuff before introducing it might fare better.

More info: https://news.ycombinator.com/item?id=12862025

@Hotell
Copy link
Contributor

Hotell commented Nov 3, 2016

As I've suggested by person in London 😉 I think it would be very nice to port docs to gitbook and have similar experience like "readers" of redux or ngMetadata have. I'm here to help with this. just lemme know if you think it's good idea and wanna proceed.

@treshugart
Copy link
Member Author

Yeah, more than happy to do that. I think it would be simpler than maintaining a website, though, the website is a great as a suite of example components. But dev speed > website IMO, so go for it!

@ghost
Copy link

ghost commented Nov 14, 2016

Personally, I'd like to add an example of rxjs and skatejs (stateless components).

@treshugart
Copy link
Member Author

@haoxins that's a great idea. I haven't had a chance to use RXJS yet, but if anyone has, I'd be really interested how this might work out.

@pyrossh
Copy link

pyrossh commented Nov 22, 2016

I think integrations with redux, mobx or even relay(v2) might help new users to use skatejs as a complete frontend solution as a replacement to react or angular.

@jeznag
Copy link

jeznag commented Jan 16, 2017

Would be great to add docs on the toolchain required. I can't figure out how to get this example going: https://hackernoon.com/building-a-custom-tag-input-with-skate-js-fbd4cdf744f#.5pmuikday

I get this error:
image

There's probably some obvious webpack/babel plugin to use. Is it just the JSX loader?

@treshugart
Copy link
Member Author

@jeznag replied via Twitter. See https://skatejs.gitbooks.io/skatejs/content/docs/api/#jsx. You don't need any special tools if you're doing raw JS. If you want to use JSX, you have to enable it.

@chrisdarroch chrisdarroch mentioned this issue Sep 24, 2017
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants