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

Clearer API documentation? #15

Open
genyded opened this issue May 3, 2016 · 2 comments
Open

Clearer API documentation? #15

genyded opened this issue May 3, 2016 · 2 comments

Comments

@genyded
Copy link

genyded commented May 3, 2016

Syntax differences without concise API documentation (what the actual API is, not sample code using a portion of it) make it hard to figure out what is allowed. For example, the readme has this example:

mount(MainLayout, {
  content: () => (<WelcomeComponent name="Arunoda" />)
});

And the sample repo has this:

mount(AuthCheckCtx, {
   LayoutDefault, content: () => (<Simplest title="Template..."/>)
});

...one has the layout component inside the object with another auth component outside and the other just outside. So can the object have nested components or just one and either way what args can and can't be inside and/or the object optionally or required?

Thanks

@zackng
Copy link

zackng commented May 6, 2016

Agree. Can the documentation also show example pure js React component in use.

Great job btw!

@sascha1337
Copy link

please some examples, need this 4 production THX

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants