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

Some thoughts on the README #36

Open
c089 opened this issue Jul 12, 2013 · 1 comment
Open

Some thoughts on the README #36

c089 opened this issue Jul 12, 2013 · 1 comment

Comments

@c089
Copy link
Member

c089 commented Jul 12, 2013

While the README generally did a good job on getting us started on exploring the app-template, there were a few things we were confused by while reading the documentation:

We set the property identifier on the view constructor to aid in the view hydration process. More on that later.

However, there is no mention of "hydration" further down in the README... We are still wondering why it is required to have this property on View constructors, but not e.g. on the Controller constructor.

We also think the following statement

Because of a trick in the way we do Stitch packaging, this module path works in the browser as well.

justifies more explanation, at least a pointer to where that "trick" is implemented so we can understand what's going on.

Please let us know if this it the right place to place to ask this kind of question. We'd also like to aid in the documentation process so I'll keep opening pull requests even for typos or when we try to make things clearer while we explore and evaluate rendr for our needs - unless you don't like that kind of micro-improvement :)

Thanks for the great project!

@spikebrehm
Copy link
Member

Agreed Christoph, thanks for bringing this up. I'll revamp the docs with
the upcoming 0.5.0 release.

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

2 participants