search

IntelLabs / RiverTrail

An API for data parallelism in JavaScript
Other
748 stars 71 forks source link

Update documentation/wiki pages/READMEs #44

Closed lkuper closed 9 years ago

lkuper commented 9 years ago

This repo's docs, wiki pages, and READMEs could use a refresh.

lkuper commented 9 years ago

Assigning myself. @jsreeram, feel free to work on it if you want.

lkuper commented 9 years ago

OK. I've now updated various READMEs and done some wiki gardening, in particular on the Home page: removing outdated info, fixing or removing broken links, etc. I still want to update Device Selection with new screenshots.

I have not made any changes to the API documentation; not sure if any need to be made.

lkuper commented 9 years ago

I've now updated the Device Selection page.

@jsreeram, is there any more doc updating you think we need to do?

lkuper commented 9 years ago

I do want to still take a pass over the tutorial.

lkuper commented 9 years ago

The tutorial is now back up. I'm working on taking a pass over it. I think that the ParallelArray constructor examples are unclear, especially the angle bracket notation, and we should show what an actual console interaction looks like.

lkuper commented 9 years ago

I've been making my way through tutorial revisions. I also plan to take a pass over the API docs. But I don't think either of these things should hold back the Pre-PPoPP release. I'll take this off the milestone.

lkuper commented 9 years ago

I've finished updating the tutorial and all the API docs, so I think this is OK to close.