Skip to content

Commit 959c224

Browse files
committed
more doc fixes
1 parent 8c4de69 commit 959c224

File tree

3 files changed

+15
-47
lines changed

3 files changed

+15
-47
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
* [Using the Generators](rails-installation/generators.md)
88
* [File Structure](rails-installation/file-structure.md)
99
* [Other Rails Configuration Details](rails-installation/other-details.md)
10+
* [Why Rails and Other Frameworks](rails-installation/why-rails.md)
1011
* [Client DSL](client-dsl/README.md)
1112
* [HTML & CSS DSL](client-dsl/html-css.md)
1213
* [Component DSL](client-dsl/components.md)

docs/client-dsl/html-css.md

Lines changed: 8 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ end
4949

5050
The following HTML and SVG elements are available:
5151

52-
<details><summary>HTML Tags</summary><div><pre><code>
52+
<details>
53+
<summary>HTML Tags</summary><div><pre><code>
5354
A ABBR ADDRESS AREA ARTICLE ASIDE AUDIO
5455
B BASE BDI BDO BIG BLOCKQUOTE BODY BR BUTTON
5556
CANVAS CAPTION CITE CODE COL COLGROUP
@@ -71,35 +72,12 @@ TABLE TBODY TD TEXTAREA TFOOT TH THEAD TIME TITLE TR TRACK
7172
U UL
7273
VAR VIDEO
7374
WBR
74-
</code></pre></div></details>
75+
</code></pre></div>
76+
</details>
7577

76-
<!-- {% fold summary="HTML Tags" %}
77-
```
78-
A ABBR ADDRESS AREA ARTICLE ASIDE AUDIO
79-
B BASE BDI BDO BIG BLOCKQUOTE BODY BR BUTTON
80-
CANVAS CAPTION CITE CODE COL COLGROUP
81-
DATA DATALIST DD DEL DETAILS DFN DIALOG DIV DL DT
82-
EM EMBED
83-
FIELDSET FIGCAPTION FIGURE FOOTER FORM
84-
H1 H2 H3 H4 H5 H6 HEAD HEADER HR HTML
85-
I IFRAME IMG INPUT INS
86-
KBD KEYGEN
87-
LABEL LEGEND LI LINK
88-
MAIN MAP MARK MENU MENUITEM META METER
89-
NAV NOSCRIPT
90-
OBJECT OL OPTGROUP OPTION OUTPUT
91-
P PARAM PICTURE PRE PROGRESS
92-
Q
93-
RP RT RUBY
94-
S SAMP SCRIPT SECTION SELECT SMALL SOURCE SPAN STRONG STYLE SUB SUMMARY SUP
95-
TABLE TBODY TD TEXTAREA TFOOT TH THEAD TIME TITLE TR TRACK
96-
U UL
97-
VAR VIDEO
98-
WBR
99-
```
100-
{% endfold %} -->
10178

102-
<details><summary>SVG Tags</summary><div><pre><code>
79+
<details>
80+
<summary>SVG Tags</summary><div><pre><code>
10381
CIRCLE CLIPPATH
10482
DEFS
10583
ELLIPSE
@@ -111,23 +89,9 @@ RADIALGRADIENT RECT
11189
STOP
11290
SVG
11391
TEXT TSPAN
114-
</code></pre></div></details>
92+
</code></pre></div>
93+
</details>
11594

116-
<!-- {% fold summary="SVG Tags" %}
117-
```
118-
CIRCLE CLIPPATH
119-
DEFS
120-
ELLIPSE
121-
G
122-
LINE LINEARGRADIENT
123-
MASK
124-
PATH PATTERN POLYGON POLYLINE
125-
RADIALGRADIENT RECT
126-
STOP
127-
SVG
128-
TEXT TSPAN
129-
```
130-
{% endfold %} -->
13195

13296
### HTML parameters
13397

docs/rails-installation/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ Adding Hyperstack to your existing Rails App is as simple as adding the gem and
66

77
Continue to the next section to make sure you have the necessary prerequisites on your machine.
88

9-
<details><summary>Why Rails?</summary><blockquote class="blockQuote-7a0db092" data-key="a435ea02d5d640c78b69d333e0891d40">
9+
<details>
10+
<summary>Why Rails?</summary><blockquote class="blockQuote-7a0db092" data-key="a435ea02d5d640c78b69d333e0891d40">
1011
<p class="blockParagraph-544a408c--blockParagraphQuoted-280e03a6" data-key="7e36607405794257b6f705a5f405176b"><span class="text-4505230f--TextH400-3033861f--textContentFamily-49a318e1"><span data-key="6898e228ab654c9ea8ee708813678acb"><span data-offset-key="6898e228ab654c9ea8ee708813678acb:0">Rails provides a robust, tried and true tool chain that takes care of much of the day to day details of building your app. Hyperstack builds on the Rails philosophy of convention over configuration, meaning that there is almost no boiler plate code in your Rails-Hyperstack application. Almost every line that you write for your Hyperstack application will deal with the application requirements. We have seen real reductions of up to 400% in the lines of code needed to deliver high quality functionality.</span></span></span></p><p class="blockParagraph-544a408c--blockParagraphQuoted-280e03a6" data-key="9750ee2895bd47d0a00b04fdaccd695b"><span class="text-4505230f--TextH400-3033861f--textContentFamily-49a318e1"><span data-key="f121bd21c43a48358aa92c88241e130b"><span data-offset-key="f121bd21c43a48358aa92c88241e130b:0">People sometimes balk at Rails because when they see the huge number of files and directories generated by the Rails installer, it looks crazy, complex, and ineffecient. Keep in mind that this has very little if any impact on your applications performance, and when developing code 90% of your time will be spent in the following directories: </span><span data-offset-key="f121bd21c43a48358aa92c88241e130b:1"><code spellcheck="false" class="code-0458e21e" data-slate-leaf="true">app/models</code></span><span data-offset-key="f121bd21c43a48358aa92c88241e130b:2"> and </span><span data-offset-key="f121bd21c43a48358aa92c88241e130b:3"><code spellcheck="false" class="code-0458e21e" data-slate-leaf="true">app/hyperstack</code></span><span data-offset-key="f121bd21c43a48358aa92c88241e130b:4">. The rest of the files are there to hold configuration files, and seldom used content, so they have a place out of the way of your main development activities.</span></span></span></p><p class="blockParagraph-544a408c--blockParagraphQuoted-280e03a6" data-key="449b3ec1d2524de3a81b19fb34c59b97"><span class="text-4505230f--TextH400-3033861f--textContentFamily-49a318e1"><span data-key="c61315faca2b4185a4cc9af22127937a"><span data-offset-key="c61315faca2b4185a4cc9af22127937a:0">Developers often believe that Rails modules like ActionController and ActiveRecord while powerful are slow. In the case of Hyperstack this is largely irrelevant since one of our goals is to offload as much work to the client as possible. For example rather than have a multitude of controllers delivering different page views and updates, your client side Hyperstack code is now responsible for that. The role of the server becomes the central database, and the place where secure operations are executed (such as sending mail, authenticating users etc.)</span></span></span></p><h1 id="how-about-other-rack-frameworks" class="blockHeading-442b4f12--blockHeading1WithMargin-b69d755e" data-key="8907e47ed3a640f4bb1158732d115e43"><div class="blockHeadingContent-756c9114"><span class="text-4505230f--HeadingH700-04e1a2a3--textContentFamily-49a318e1"><span data-key="f5da9790974945228e54d4ccda53e74a"><span data-offset-key="f5da9790974945228e54d4ccda53e74a:0">How about other Rack Frameworks</span></span></span><a href="#how-about-other-rack-frameworks" contenteditable="false" class="blockHeadingAnchor-34f75d78--blockHeadingAnchorHidden-d69b5eda"><span class="blockHeadingAnchorIcon-1c2bf3cb"><svg preserveAspectRatio="xMidYMid meet" height="1em" width="1em" fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" stroke="currentColor" class="icon-7f6730be--text-3f89f380"><g><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path></g></svg></span></a></div><div role="button" tabindex="0" contenteditable="false" class="reset-3c756112--blockHeadingUp-c32402b2" style="color: rgb(61, 66, 72);"><svg preserveAspectRatio="xMidYMid meet" height="1em" width="1em" fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" stroke="currentColor" class="icon-7f6730be--text-3f89f380"><g><line x1="12" y1="19" x2="12" y2="5"></line><polyline points="5 12 12 5 19 12"></polyline></g></svg></div></h1><p class="blockParagraph-544a408c--blockParagraphQuoted-280e03a6" data-key="d77c91ee1db14111bdce9f02822dfdc6"><span class="text-4505230f--TextH400-3033861f--textContentFamily-49a318e1"><span data-key="ffdfe4e348f344bda203da0daaa348c2"><span data-offset-key="ffdfe4e348f344bda203da0daaa348c2:0">But still you may have specific needs for a lighter weight system, or have an existing Sinatra app (for example) that you would like to use with Hyperstack. For now we will say its in the plan, and its just a matter of time. If you are interested leave a comment on this issue: </span></span><a class="link-a079aa82--primary-53a25e66--link-faf6c434" href="https://github.com/hyperstack-org/hyperstack/issues/340" target="_blank" rel="noopener noreferrer" data-key="c2e2224d1f1b407297e72ec0a79fc872" style="color: rgb(61, 66, 72);"><span data-key="74ec8d5f462d4e958d6790fee474eca1"><span data-offset-key="74ec8d5f462d4e958d6790fee474eca1:0">https://github.com/hyperstack-org/hyperstack/issues/340</span></span></a><span data-key="028a4d43265e4066a9fad68152392552"><span data-offset-key="028a4d43265e4066a9fad68152392552:0"><span data-slate-zero-width="z">&#8203;</span></span></span></span></p></blockquote>
1112
</details>
1213

1314

14-
<!-- {% fold summary="Why Rails?" %}
15+
{% fold summary="Why Rails?" %}
16+
1517
>Rails provides a robust, tried and true tool chain that takes care of much of the day to day details of building your app. Hyperstack builds on the Rails philosophy of convention over configuration, meaning that there is almost no boiler plate code in your Rails-Hyperstack application. Almost every line that you write for your Hyperstack application will deal with the application requirements. We have seen real reductions of up to 400% in the lines of code needed to deliver high quality functionality.
1618
>
1719
>People sometimes balk at Rails because when they see the huge number of files and directories generated by the Rails installer, it looks crazy, complex, and ineffecient. Keep in mind that this has very little if any impact on your applications performance, and when developing code 90% of your time will be spent in the following directories: `app/models` and `app/hyperstack`. The rest of the files are there to hold configuration files, and seldom used content, so they have a place out of the way of your main development activities.
@@ -22,4 +24,5 @@ In the case of Hyperstack this is largely irrelevant since one of our goals is t
2224
>### How about other Rack Frameworks
2325
>
2426
>But still you may have specific needs for a lighter weight system, or have an existing Sinatra app (for example) that you would like to use with Hyperstack. For now we will say its in the plan, and its just a matter of time. If you are interested leave a comment on this issue: https://github.com/hyperstack-org/hyperstack/issues/340
25-
{% endfold %} -->
27+
28+
{% endfold %}

0 commit comments

Comments
 (0)