Skip to content

Commit e945da0

Browse files
committed
docs adjustments
1 parent 938f706 commit e945da0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+26
-9828
lines changed

README.md

Lines changed: 13 additions & 472 deletions
Large diffs are not rendered by default.

docs/README.md

Lines changed: 7 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,29 @@
11
---
22
description: >-
33
Matestack Ui Core - Boost your productivity & easily create component based
4-
web UIs in pure Ruby. Reactivity based on Vue.js included if desired. No Opal
5-
involved.
4+
web UIs in pure Ruby.
65
---
76

87
# Welcome
98

109
{% hint style="info" %}
11-
Version 2.0.0 was released on the 12th of April and proudly presented at RailsConf. Click here for more [details](migrate-from-1.x-to-2.0.md)
10+
Version 3.0.0 was released on the xth of February 2022 and proudly presented at RailsConf. Click here for more [details](migrate-from-2.x-to-3.0.md)
1211

1312
**Most important changes:**
1413

15-
* Changed to MIT License
16-
* 5 to 12 times better rendering performance \(depending on the context\)
17-
* Removed Trailblazer dependency
18-
* Improved core code readability/maintainability
19-
{% endhint %}
20-
21-
## **What is Matestack?**
22-
23-
Matestack enables Rails developers to craft maintainable web UIs in pure Ruby, skipping ERB and HTML. UI code becomes a native and fun part of your Rails app. Thanks to reactive core components built on top of Vue.js, reactivity can be optionally added without writing JavaScript, just using a simple Ruby DSL.
14+
* Split `matestack-ui-core` into `matestack-ui-core` and `matestack-ui-vue_js`
15+
* Rails 7 support
16+
* Vue 3 support in `matestack-ui-vue_js`
2417

25-
If necessary, extend with pure JavaScript. **No Opal involved.**
26-
27-
{% hint style="success" %}
28-
**Share feedback, get support and get involved!** Join our growing [community](community/discord.md), get to know the [core team](about/team.md) and learn how to [contribute ](community/contribute.md)in order to make Matestack better every day!
2918
{% endhint %}
3019

31-
## Why Matestack?
32-
33-
Matestack presented and explained at RailsConf 2021:
34-
35-
{% embed url="https://www.youtube.com/watch?v=bwsVgCb97v0" %}
36-
37-
Matestack was created because modern web app development became more and more complex due to the rise of JavaScript frontend frameworks and the SPA frontend/REST API/JSON backend architecture. This sophisticated approach might be suitable for big teams and applications but is way to complex for most of small to medium sized teams and application scopes.
38-
39-
In contrast, Matestack helps Rails developers creating modern, reactive web apps while focusing on **simplicity**, **developer happiness** and **productivity**:
40-
41-
* [x] Use Ruby’s amazing language features while creating your UI
42-
* [x] Skip using templating engine syntax and write pure Ruby instead
43-
* [x] Reduce the amount of required JavaScript in order to build reactive web UIs
44-
* [x] Create a single application, managing the full stack from database to a reactive UI in pure Ruby
45-
* [x] **Drastically reduce the complexity of building reactive web applications**
46-
47-
## What makes Matestack different?
48-
49-
[Hotwire](https://hotwire.dev) and [Stimulus Reflex](https://docs.stimulusreflex.com) are awesome gems. They reduce the amount of required JavaScript when implementing reactive web UIs. They allow us to use more Rails and less JavaScript. **Great!**
50-
51-
Matestack, developed since 2018, goes even one step further: **Use more Ruby and less of everything else** \(JavaScript, ERB/HAML/SLIM, CSS\).
52-
53-
{% hint style="info" %}
54-
**Why?** Because Ruby is just beautiful! More Ruby = More developer happiness = Higher productivity
55-
{% endhint %}
56-
57-
Additionally, most of Matestack does not require Action Cable or Redis, but can optionally use the power of these tools.
58-
59-
## Ecosystem
60-
61-
Matestack currently offers two open source Ruby gems**:**
62-
63-
* `matestack-ui-core` ships all you need to build reactive UIs in pure Ruby. You have to take care of styling and additional UI components yourself.
64-
* `matestack-ui-bootstrap`ships all you need to build beautiful, reactive UIs in pure Ruby and smart CRUD components based on Bootstrap v5. Don't think about styling anymore and just create admin or application UIs faster than ever before! **-->** [https://docs.matestack.io/matestack-ui-bootstrap/](https://docs.matestack.io/matestack-ui-bootstrap/)
65-
66-
## Live Demo
67-
68-
Based on `matestack-ui-core` and `matestack-ui-bootstrap` this reactive dummy app was created in pure Ruby without writing any JavaScript, ERB/HAML/SLIM and CSS: \([check it out](https://dummy.matestack.io) \| [source code](https://github.com/matestack/matestack-ui-bootstrap/tree/main/spec/dummy)\)
69-
70-
![https://dummy.matestack.io](.gitbook/assets/image%20%281%29.png)
71-
7220
## Compatibility
7321

7422
### Ruby/Rails
7523

76-
`matestack-ui-core` and `matestack-ui-bootstrap` are automatically tested against:
24+
`matestack-ui-core` is automatically tested against:
7725

26+
* Rails 7.0.1 + Ruby 3.0.0
7827
* Rails 6.1.1 + Ruby 3.0.0
7928
* Rails 6.1.1 + Ruby 2.7.2
8029
* Rails 6.0.3.4 + Ruby 2.6.6
@@ -84,36 +33,8 @@ Based on `matestack-ui-core` and `matestack-ui-bootstrap` this reactive dummy ap
8433
Rails versions below 5.2 are not supported.
8534
{% endhint %}
8635

87-
### Vue.js
88-
89-
`matestack-ui-core` requires Vue.js and Vuex for its reactivity features. Following version ranges are supported:
90-
91-
* Vue.js ^2.6.0
92-
* Vuex ^3.6.0
93-
94-
{% hint style="info" %}
95-
Vue 3 / Vuex 4 update is planned for Q2 2021.
96-
{% endhint %}
97-
98-
### Webpacker/Sprockets
99-
100-
`matestack-ui-core` is designed to be installed via Npm or Yarn and bundled via something like Webpacker together with all your other dependencies.
101-
102-
{% hint style="warning" %}
103-
Since 2.0.0 we're not shipping a pre-bundled JavaScript assets for Rails assets pipeline \(Sprockets\) users anymore.
104-
{% endhint %}
105-
10636
## Getting Started
10737

10838
Before you dive into some code, you should read about the basic architecture concepts and different ways to build with Matestack:
10939

11040
{% page-ref page="getting-started/concepts-rails-integration.md" %}
111-
112-
After that, it might be a good idea to boost your knowledge with our quick start guide:
113-
114-
{% page-ref page="getting-started/quick-start.md" %}
115-
116-
## Roadmap
117-
118-
Do you want to know what we're currently working on and what's planned for the next releases? Check out our GitHub Project board: [https://github.com/orgs/matestack/projects/1](https://github.com/orgs/matestack/projects/1)
119-

docs/SUMMARY.md

Lines changed: 1 addition & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
# Table of contents
22

33
* [Welcome](README.md)
4-
* [Migrating from 1.x to 2.0](migrate-from-1.x-to-2.0.md)
4+
* [Migrating from 2.x to 3.0](migrate-from-2.x-to-3.0.md)
55

66
## Getting started
77

88
* [Installation & Update](getting-started/installation-update.md)
99
* [Concepts & Rails Integration](getting-started/concepts-rails-integration.md)
10-
* [Tutorial](getting-started/quick-start.md)
11-
* [Support & Feedback \[WIP\]](getting-started/support-and-feedback.md)
12-
* [Common Issues \[WIP\]](getting-started/common-issues.md)
1310

1411
## HTML implemented in pure Ruby <a id="ui-in-pure-ruby"></a>
1512

@@ -25,70 +22,3 @@
2522
* [Apps](ui-in-pure-ruby/apps/README.md)
2623
* [App API](ui-in-pure-ruby/apps/app-api-1.md)
2724
* [Reusing Rails Views or Partials](ui-in-pure-ruby/reusing-views-or-partials.md)
28-
29-
## Built-in Reactivity composed in pure Ruby <a id="built-in-reactivity"></a>
30-
31-
* [Overview](built-in-reactivity/overview.md)
32-
* [Emit Client Side Events](built-in-reactivity/emit-client-side-events/README.md)
33-
* [Onclick Component API](built-in-reactivity/emit-client-side-events/onclick-component-api.md)
34-
* [Toggle UI States](built-in-reactivity/toggle-ui-states/README.md)
35-
* [Toggle Component API](built-in-reactivity/toggle-ui-states/toggle-component-api.md)
36-
* [Call Server Side Actions](built-in-reactivity/call-server-side-actions/README.md)
37-
* [Overview](built-in-reactivity/call-server-side-actions/overview.md)
38-
* [Action Component API](built-in-reactivity/call-server-side-actions/action-component-api.md)
39-
* [Reactive Forms](built-in-reactivity/reactive-forms/README.md)
40-
* [Overview](built-in-reactivity/reactive-forms/overview.md)
41-
* [Form Component API](built-in-reactivity/reactive-forms/form-component-api.md)
42-
* [Input Component API](built-in-reactivity/reactive-forms/form-input-component-api.md)
43-
* [Textarea Component API](built-in-reactivity/reactive-forms/form-textarea-component-api.md)
44-
* [Checkbox Component API](built-in-reactivity/reactive-forms/form-checkbox-component-api.md)
45-
* [Select Component API](built-in-reactivity/reactive-forms/form-select-component-api.md)
46-
* [Radio Component API](built-in-reactivity/reactive-forms/form-radio-component-api.md)
47-
* [Nested Forms](built-in-reactivity/reactive-forms/nested-forms.md)
48-
* [Partial UI Updates](built-in-reactivity/partial-ui-updates/README.md)
49-
* [Overview](built-in-reactivity/partial-ui-updates/overview.md)
50-
* [Async Component API](built-in-reactivity/partial-ui-updates/async-component-api.md)
51-
* [Cable Component API](built-in-reactivity/partial-ui-updates/cable-component-api.md)
52-
* [Isolated Component API](built-in-reactivity/partial-ui-updates/isolated-component-api.md)
53-
* [Page Transitions](built-in-reactivity/page-transitions/README.md)
54-
* [Overview](built-in-reactivity/page-transitions/overview.md)
55-
* [Transition Component API](built-in-reactivity/page-transitions/transition-component-api.md)
56-
* [Reactive Collections](built-in-reactivity/reactive-collections/README.md)
57-
* [Overview](built-in-reactivity/reactive-collections/overview.md)
58-
* [Collection Component API \[WIP\]](built-in-reactivity/reactive-collections/collection-component-api.md)
59-
60-
## Custom Reactivity implemented in Vue.js <a id="custom-reactivity"></a>
61-
62-
* [Custom Vue.js Components](custom-reactivity/custom-vue-js-components.md)
63-
* [Third party Vue.js components \[WIP\]](custom-reactivity/third-party-vue.js-components-wip.md)
64-
* [Matestack's Vue.js APIs \[WIP\]](custom-reactivity/matestacks-vue.js-apis-wip.md)
65-
* [Matestack's Vuex API \[WIP\]](custom-reactivity/matestacks-vuex-api-wip.md)
66-
67-
## Integrations
68-
69-
* [Action Cable](integrations/action-cable.md)
70-
* [Devise](integrations/devise.md)
71-
* [Authorization \[WIP\]](integrations/authorization.md)
72-
* [CSS Frameworks \[WIP\]](integrations/css-frameworks.md)
73-
* [Third Party JavaScript \[WIP\]](integrations/third-party-javascript.md)
74-
* [Third Party Ruby Gems \[WIP\]](integrations/third-party-ruby-gems.md)
75-
76-
## Matestack Addons
77-
78-
* [Create your own Addon \[WIP\]](matestack-addons/create-your-own-addon-wip.md)
79-
80-
## Testing
81-
82-
* [Capybara & Rspec](testing/capybara-and-rspec.md)
83-
84-
## Community
85-
86-
* [Discord](community/discord.md)
87-
* [Contribute \[WIP\]](community/contribute.md)
88-
89-
## About
90-
91-
* [Core Team](about/team.md)
92-
* [Sponsoring \[WIP\]](about/sponsoring-wip.md)
93-
* [Legal Details \[WIP\]](about/legal-details-wip.md)
94-

docs/about/legal-details-wip.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/about/sponsoring-wip.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/about/team.md

Lines changed: 0 additions & 60 deletions
This file was deleted.

docs/built-in-reactivity/call-server-side-actions/README.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)