List of website feedback, comments in the ycombinator discussion, issues arising in the chat and things to do:
Need to clarify that the even though the Getting Started example uses Hyperloop Express this is unlikely to be the solution in production done
~~Need a consistent approach to code snippets, allowing them to be editable like in the old site or links to "Try this" in Opal Playground ~~
ChatApp needs some new Bootstrap 4 styling and have the running app in situ with the tutorial
Adding RUBY_ENGINE ‘opal’ block when doing a require_tree for public models
Removing eager_load_paths and autoload_paths when deploying to production
Clarity on the generators not supporting Rails 5 yet done
Check install guides state Opal.load('components') step in application.js
Clarify that built in html can be upper or lowercase (div vs DIV)
Fix the Composition example (referencing Element['#container'] unnecessarily). Perhaps fixed with a consistent approach to sample code.
All documentation examples should not assume the reader is using Hyperloop Express or Opal Playground and this should be made clear
Examples all follow something like: 1) The example is a stand alone set of classes that does something, 2) It is running in a live editor window, 3) There is some kind of menu that has "things to try" to encourage some experimentation, 4) There is link 'run this on your own desk top' that would have the general instructions (same for all examples) talking about setting up either a simple rails app, or a reactrb-express app - OR just provide a clear context in which the example can be run.
Not clear how to render a component from a view
Gem documentation that needs improving:
Hyper Router (Reactrb Router) 2-4-0 branch should be promoted to master and documentation needs improving
-~~ Reactive Record & Synchromesh readme's need improving and perhaps need erging (taking new docs from the Synchromesh https://github.com/reactrb/synchromesh/tree/authorization-policies/docs) - I am guessing the release of this branch is imminent ~~
barriehadfield
commented
7 years ago
List of website feedback, comments in the ycombinator discussion, issues arising in the chat and things to do:
Need to clarify that the even though the Getting Started example uses Hyperloop Express this is unlikely to be the solution in productiondoneAdding RUBY_ENGINE ‘opal’ block when doing a require_tree for public modelsRemoving eager_load_paths and autoload_paths when deploying to productionClarity on the generators not supporting Rails 5 yetdoneCheck install guides state Opal.load('components') step in application.jsFix the Composition example (referencing Element['#container'] unnecessarily). Perhaps fixed with a consistent approach to sample code.All documentation examples should not assume the reader is using Hyperloop Express or Opal Playground and this should be made clearNot clear how to render a component from a viewGem documentation that needs improving: