Skip to content

Commit 8f54e2d

Browse files
client-dsl reorginization and better summary
1 parent edcc469 commit 8f54e2d

12 files changed

Lines changed: 1904 additions & 1885 deletions

docs/SUMMARY.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,17 @@
55
* [Installation](installation/man-installation.md)
66
* [Configuration](installation/config.md)
77
* [Upgrading from legacy Hyperloop](installation/upgrading.md)
8-
* [Tutorial](tutorial/README.md)
9-
* [TodoMVC Tutorial Part I](tutorial/todo.md)
10-
* [TodoMVC Tutorial Part II](tutorial/todo-part-2.md)
11-
* [Community](community.md)
128
* [Client DSL](client-dsl/README.md)
13-
* [HTML and Component DSL](client-dsl/hyper-component.md)
9+
* [HTML & CSS DSL](client-dsl/html-css.md)
10+
* [Component DSL](client-dsl/components.md)
11+
* [Lifecycle Methods](client-dsl/lifecycle-methods.md)
12+
* [State](client-dsl/state.md)
13+
* [Event Handlers](client-dsl/event-handlers.md)
14+
* [JavaScript Components](client-dsl/javascript-components.md)
1415
* [Client-side Routing](client-dsl/hyper-router.md)
1516
* [Stores](client-dsl/hyper-store.md)
17+
* [Elements and Rendering](client-dsl/elements-and-rendering.md)
18+
* [Further Reading](client-dsl/further-reading.md)
1619
* [Isomorphic DSL](isomorphic-dsl/README.md)
1720
* [Isomorphic Models](isomorphic-dsl/hyper-model.md)
1821
* [Isomorphic Operations](isomorphic-dsl/hyper-operation.md)
@@ -22,5 +25,8 @@
2225
* [Internationalization](development-workflow/hyper-i18n.md)
2326
* [HyperSpec](development-workflow/hyper-spec.md)
2427
* [Tools](development-workflow/tools.md)
25-
* [Feature Matrix](feature_matrix.md)
28+
* [Tutorial](tutorial/README.md)
29+
* [TodoMVC Tutorial Part I](tutorial/todo.md)
30+
* [TodoMVC Tutorial Part II](tutorial/todo-part-2.md)
31+
* [Community](community.md)
2632

docs/client-dsl/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,19 @@
11
# Client DSL
22

3+
## HTML DSL and Hyperstack Component classes
4+
5+
A key design goal of the DSL \(Domain Specific Language\) is to make it work seamlessly with the rest of Ruby and easy to work with HTML elements and Components. Additionally, the DSL provides an abstraction layer between your code and the underlying \(fast moving\) technology stack. Hyperstack always uses the very latest versions of React and React Router yet our DSL does not change often. We believe that a stable DSL abstraction is an advantage.
6+
7+
This documentation will cover the following core concepts:
8+
9+
+ [HTML & CSS DSL](html-css.md) which provided Ruby implementations of all of the HTML and CSS elements
10+
+ [Component DSL](components.md) is a Ruby DSL which wraps ReactJS Components
11+
+ [Lifecycle Methods](lifecycle-methods.md) are methods which are invoked before, during and after rendering
12+
+ [State](state.md) governs all rendering in ReactJS
13+
+ [Event Handlers](event-handlers.md) allow any HTML element or Component can respond to an event
14+
+ [JavaScript Components](javascript-components.md) for the full universe of JS libraries in your Ruby code
15+
+ [Client-side Routing](hyper-router.md) a Ruby DSL which wraps ReactRouter
16+
+ [Stores](hyper-store.md) for application level state and Component communication
17+
+ [Elements and Rendering](elements-and-rendering.md) which are seldom used but useful to know
18+
+ [Further Reading](further-reading.md) on React and Opal
19+

0 commit comments

Comments
 (0)