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

Vapoware? #66

Closed
gnimmelf opened this issue May 9, 2014 · 9 comments
Closed

Vapoware? #66

gnimmelf opened this issue May 9, 2014 · 9 comments

Comments

@gnimmelf
Copy link

gnimmelf commented May 9, 2014

I'm confused by the Example -warning in the readme:

Warning: Vaporware. The virtual-dom is not implemented yet.

What do you mean?

@Raynos
Copy link
Collaborator

Raynos commented May 9, 2014

It means the README hasn't been written yet and was copy pasted directly out of my gist https://gist.github.com/Raynos/8414846

@Raynos
Copy link
Collaborator

Raynos commented May 9, 2014

@Matt-Esch we should update the README :)

@Matt-Esch
Copy link
Owner

Yeah, we really need proper docs, starting with a valid README. I think we're at a point where we can nail down the features. Mainly, that means disclaimer, it's not tested nearly as much as I would like, subject to changes and has not been proved in the non-trivial case. Just as we found that reordering was completely wrong after testing Raynos/mercury#2048-wip, what needs to happen is a full rearrangement of the modules here, tests for the individual units and a bunch of integration tests at the virtual-dom level. Proper docs so we actually know how all the mechanisms work is a must and upcoming feature.

In short, it was added when the functions didn't exist, and it's currently acting as a disclaimer to warn that this is volatile. The README is out of date, not all of the functions documented exist and there are a number of internal things that are not mentioned at all. Thunks, widgets, hooks etc.

I'll bump this up in my priority list.

@countable
Copy link

I'm interested in this project and may have some time to contribute if missing things are listed clearly. :)

@gnimmelf
Copy link
Author

Bump. I would also like to contribute, but need to be spoon fed tasks :-)

@neonstalwart
Copy link
Collaborator

for anyone interested, #virtualdom on freenode is one way available to help facilitate any collaboration or to answer any questions - feel free to join us.

@neonstalwart
Copy link
Collaborator

also, you may be interested in the mercury project that pulls together this piece and a number of other related pieces into a "framework"

@Raynos
Copy link
Collaborator

Raynos commented May 15, 2014

👍 about #virtualdom on freenode irc.

Also see:

I've been tracking things i've been wanting to work on.

@countable
Copy link

Interesting stuff, thanks! I'll follow both and get updates, and hopefully jump in to help out if I can find some time!

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

5 participants