diff --git a/docs/feature_matrix.md b/docs/feature_matrix.md new file mode 100644 index 000000000..66ccb1610 --- /dev/null +++ b/docs/feature_matrix.md @@ -0,0 +1,13 @@ +# Feature Matrix +Table with Ruby (on Rails) features and the implemenatation status for Hyperstack/Opal. + +| Feature | Type | Module | Status | Links | Exsisting Documenation | Exsisting Server Implementations | Implemenation At** | +|-------------|-----------------|---------------|----------|----------------|------------------------|----------------------------------|--------------------| +| new_record? | instance method | ActiveRecord | missing | Github issues? | [new_record?@apidock](https://api.rubyonrails.org/classes/ActiveRecord/Persistence.html#method-i-new_record-3F) | | [hyper-model](https://github.com/hyperstack-org/hyperstack/blob/edge/ruby/hyper-model/lib/reactive_record/active_record/instance_methods.rb) | +| find | class method | ActiveRecord | buged? | [reproducable example](https://github.com/Tim-Blokdijk/hyperstack-experiments/blob/master/app/hyperstack/components/search.rb) | | | [hyper-model](https://github.com/hyperstack-org/hyperstack/blob/edge/ruby/hyper-model/lib/reactive_record/active_record/class_methods.rb) | +| destroy | instance method | ActiveRecord | buged? | [reproducable example](https://github.com/Tim-Blokdijk/hyperstack-experiments/blob/master/app/hyperstack/components/index.rb) | | | [hyper-model](https://github.com/hyperstack-org/hyperstack/blob/edge/ruby/hyper-model/lib/reactive_record/active_record/instance_methods.rb) | +| DateTime | class | StdLib | missing | | [DateTime@ruby-doc](https://ruby-doc.org/stdlib-2.6/libdoc/date/rdoc/DateTime.html) | | Opal | +| truncate | instance method | ActiveSupport | missing | | [truncate@apidock](https://apidock.com/rails/String/truncate) | | [opal-activesupport@github](https://github.com/opal/opal-activesupport/tree/master/opal/active_support/core_ext) | +| i18n | lib | Rails-I18N | missing? | | | [rails-i18n@github](https://github.com/svenfuchs/rails-i18n) | | + +** Implemenation At: If `Status` is `missing` the place (file or directory) where the code should probably be impemented. Otherwise the actual implemenation Opal. diff --git a/docs/readme.md b/docs/readme.md index f38ca91b1..7719add9c 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -33,7 +33,10 @@ Our website serves as a Hyperstack example application. All the doc content is l You can be up and running in **less than 5 minutes**. Just follow the simple setup guide for a new Rails application all correctly configured and ready to go with Hyperstack. -+ Setup and Installation: [https://hyperstack.org/edge/docs/installation) ++ Setup and Installation: https://hyperstack.org/edge/docs/installation + +Beyond the installation we strongly suggest new developers work trough the [ToDo tutorial](https://github.com/hyperstack-org/hyperstack/blob/edge/docs/tutorial/todo.md). +As it gives a minial understanding of the Hyperstack framework. ## Community and support @@ -49,7 +52,12 @@ Please see the [ROADMAP](https://github.com/hyperstack-org/hyperstack/blob/edge/ ## Contributing -If you would like to help, please read the [CONTRIBUTING](https://github.com/hyperstack-org/hyperstack/blob/edge/CONTRIBUTING.md) file for suggestions. +We have a [Feature Matrix](https://github.com/hyperstack-org/hyperstack/blob/edge/docs/feature_matrix.md) that needs to be filled with missing features. +The idea is that you can check here what the implementation status is of a Ruby (on Rails) feature. +And if you have the time and skill you're more then encuraged to implement or fix one or two. +But if you're not in a position to contribute code, just expanding and maintaining this table would be very excellent. + +If you would like to help in any other way, please read the [CONTRIBUTING](https://github.com/hyperstack-org/hyperstack/blob/edge/CONTRIBUTING.md) file for suggestions. ## Links