Skip to content

Commit c0992bb

Browse files
Merge pull request #104 from Tim-Blokdijk/edge
Feature Matrix documentation
2 parents ad68001 + 185a6d6 commit c0992bb

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

docs/feature_matrix.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Feature Matrix
2+
Table with Ruby (on Rails) features and the implemenatation status for Hyperstack/Opal.
3+
4+
| Feature | Type | Module | Status | Links | Exsisting Documenation | Exsisting Server Implementations | Implemenation At** |
5+
|-------------|-----------------|---------------|----------|----------------|------------------------|----------------------------------|--------------------|
6+
| 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) |
7+
| 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) |
8+
| 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) |
9+
| DateTime | class | StdLib | missing | | [DateTime@ruby-doc](https://ruby-doc.org/stdlib-2.6/libdoc/date/rdoc/DateTime.html) | | Opal |
10+
| 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) |
11+
| i18n | lib | Rails-I18N | missing? | | | [rails-i18n@github](https://github.com/svenfuchs/rails-i18n) | |
12+
13+
** Implemenation At: If `Status` is `missing` the place (file or directory) where the code should probably be impemented. Otherwise the actual implemenation Opal.

docs/readme.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,10 @@ Our website serves as a Hyperstack example application. All the doc content is l
3333

3434
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.
3535

36-
+ Setup and Installation: [https://hyperstack.org/edge/docs/installation)
36+
+ Setup and Installation: https://hyperstack.org/edge/docs/installation
37+
38+
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).
39+
As it gives a minial understanding of the Hyperstack framework.
3740

3841
## Community and support
3942

@@ -49,7 +52,12 @@ Please see the [ROADMAP](https://github.com/hyperstack-org/hyperstack/blob/edge/
4952

5053
## Contributing
5154

52-
If you would like to help, please read the [CONTRIBUTING](https://github.com/hyperstack-org/hyperstack/blob/edge/CONTRIBUTING.md) file for suggestions.
55+
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.
56+
The idea is that you can check here what the implementation status is of a Ruby (on Rails) feature.
57+
And if you have the time and skill you're more then encuraged to implement or fix one or two.
58+
But if you're not in a position to contribute code, just expanding and maintaining this table would be very excellent.
59+
60+
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.
5361

5462
## Links
5563

0 commit comments

Comments
 (0)