updated docs

barriehadfield · barriehadfield · commit ea31070948dc · 2018-10-02T07:47:23.000+01:00
diff --git a/docs/dsl/hyper-component.md b/docs/dsl/hyper-component.md
@@ -1,6 +1,6 @@
-# HyperComponent
+# Components
 
-# Work in progress - ALPHA (docs and code)
+**Work in progress - ALPHA (docs and code)**
 
 ## Components DSL Overview
 
diff --git a/docs/dsl/hyper-i18n.md b/docs/dsl/hyper-i18n.md
@@ -1,13 +1,16 @@
-#  HyperI18n
+# Internationalization
 
-## HyperI18n gem
+## HyperI18n
 
-HyperI18n seamlessly brings Rails I18n into your Hyperloop application.
+**Work in progress - ALPHA (docs and code)**
 
+HyperI18n seamlessly brings Rails I18n into your Hyperstack application.
 
 ## Installation and Setup
 
-1. Add `gem 'hyper-i18n', git: 'https://github.com/ruby-hyperloop/hyper-i18n.git'` to your `Gemfile`
+**TODO these steps are wrong**
+
+1. Add `gem 'hyper-i18n', git: 'https://github.com/ruby-Hyperstack/hyper-i18n.git'` to your `Gemfile`
 2. Install the Gem: `bundle install`
 3. Add `require 'hyper-i18n'` to your components manifest
 
@@ -57,7 +60,7 @@ en:
 ```
 ```ruby
 module Users
-  class Show < Hyperloop::Component
+  class Show < Hyperstack::Component
     render do
       H1 { t(:title) }
     end
diff --git a/docs/dsl/hyper-model.md b/docs/dsl/hyper-model.md
@@ -1,6 +1,6 @@
-# HyperModel
+# Isomorphic Models
 
-# Work in progress - ALPHA (docs and code)
+**Work in progress - ALPHA (docs and code)**
 
 In Hyperstack, your ActiveRecord Models are available in your Isomorphic code.
 
diff --git a/docs/dsl/hyper-operation.md b/docs/dsl/hyper-operation.md
@@ -1,6 +1,6 @@
-# HyperOperations
+# Isomorphic Operations
 
-# Work in progress - ALPHA (docs and code)
+**Work in progress - ALPHA (docs and code)**
 
 Operations are the engine rooms of Hyperstack; they orchestrate the interactions between Components, external services, Models, and Stores. Operations provide a tidy place to keep your business logic.
 
diff --git a/docs/dsl/hyper-policy.md b/docs/dsl/hyper-policy.md
@@ -1,6 +1,6 @@
-# Hyperstack Policies
+# Policies
 
-TODO: THIS PAGE NEEDS LOTS OF WORK! @simon :-) all yours
+**Work in progress - ALPHA (docs and code)**
 
 ## Authorization
 
diff --git a/docs/dsl/hyper-router.md b/docs/dsl/hyper-router.md
@@ -1,6 +1,6 @@
-# HyperRouter
+# Router
 
-# Work in progress - ALPHA (docs and code)
+**Work in progress - ALPHA (docs and code)**
 
 ## Usage
 
diff --git a/docs/dsl/hyper-spec.md b/docs/dsl/hyper-spec.md
@@ -1,5 +1,7 @@
 # HyperSpec
 
+**Work in progress - ALPHA (docs and code)**
+
 With HyperSpec you can run *isomorphic* specs for all your Hyperloop code using RSpec.  Everything runs as standard RSpec test specs.  
 
 For example if you have a component like this:
diff --git a/docs/dsl/hyper-store.md b/docs/dsl/hyper-store.md
@@ -1,6 +1,6 @@
-# HyperStore
+# Stores
 
-# Work in progress - ALPHA (docs and code)
+**Work in progress - ALPHA (docs and code)**
 
 Hyperstack **Stores** are implemented in the **HyperStore Gem**.
 
diff --git a/docs/dsl/setup.md b/docs/dsl/setup.md
diff --git a/docs/installation/config.md b/docs/installation/config.md
@@ -1,4 +1,6 @@
-# Hyperloop::Configuration
+# Configuration
+
+**Work in progress - ALPHA (docs and code)**
 
 This gem is used internally by other [Hyperloop](http://ruby-hyperloop.io) gems for keeping config settings, and for registering client side autoload requirements.
 
diff --git a/docs/installation/installation.md b/docs/installation/installation.md
@@ -1,5 +1,7 @@
 # Hyperstack Rails Template
 
+**Work in progress - ALPHA (docs and code)**
+
 This template will create a new Rails app with Webpacker from Hyperstack edge branch
 
 ## Usage
diff --git a/docs/installation/upgrading.md b/docs/installation/upgrading.md
@@ -1,4 +1,4 @@
-# Hyperloop to Hyperstack
+# Upgrading from legacy Hyperloop
 
 These instructions are subject to change as the project matures.
 
diff --git a/docs/readme.md b/docs/readme.md
@@ -13,4 +13,3 @@
 + This hyperloop-legacy branch will only contain critical bug fixes
 + The original website is here: http://ruby-hyperloop.org/
 + The final stable branch is https://github.com/hyperstack-org/hyperstack/tree/hyperloop-legacy
-
diff --git a/docs/tools/debugging.md b/docs/tools/debugging.md
@@ -1,8 +1,10 @@
 # Debugging
 
+**Work in progress - ALPHA (docs and code)**
+
 ## Debugging tips
 
-Tips, good practice will help you debugging your Hyperloop application.
+Tips, good practice will help you debugging your Hyperstack application.
 
 ### JavaScript Console
 
@@ -21,7 +23,7 @@ Here are some tips: https://dev.mikamai.com/2014/11/19/3-tricks-to-debug-opal-co
 Anywhere in your HyperReact code you can simply puts any_value which will display the contents of the value in the browser console. This can help you understand React program flow as well as how data changes over time.
 
 ```ruby
-class Thing < Hyperloop::Component
+class Thing < Hyperstack::Component
   param initial_mode: 12
 
   before_mount do
diff --git a/docs/tools/tips.md b/docs/tools/tips.md
@@ -1,3 +1,5 @@
 # Tips and Tricks
 
-Everything we have learned 
+**Work in progress - ALPHA (docs and code)**
+
+Everything we have learned
diff --git a/docs/tools/tools.md b/docs/tools/tools.md
@@ -1,20 +1,22 @@
 # Tools
 
+**Work in progress - ALPHA (docs and code)**
+
 ## Hyper-console
 
 Hyper-Console will open a new popup window, that is running an IRB style read-eval loop. The console window will compile what ever ruby code you type, and if it compiles, will send it to your main window for execution. The result (or error message) plus any console output will be displayed in the console window.
 
 ## Hyper-spec
 
-With Hyper-Spec you can run isomorphic specs for all your Hyperloop code using RSpec. Everything runs as standard RSpec test specs.
+With Hyper-Spec you can run isomorphic specs for all your Hyperstack code using RSpec. Everything runs as standard RSpec test specs.
 
-Hyperloop wants to make the server-client divide as transparent to the developer as practical. Given this, it makes sense that the testing should also be done with as little concern for client versus server.
+Hyperstack wants to make the server-client divide as transparent to the developer as practical. Given this, it makes sense that the testing should also be done with as little concern for client versus server.
 
-Hyper-spec allows you to directly use tools like FactoryGirl (or Hyperloop Operations) to setup some test data, then run a spec to make sure that a component correctly displays, or modifies that data. You can use Timecop to manipulate time and keep in sync between the server and client. This makes testing easier and more realistic without writing a lot of redundant code.
+Hyper-spec allows you to directly use tools like FactoryGirl (or Hyperstack Operations) to setup some test data, then run a spec to make sure that a component correctly displays, or modifies that data. You can use Timecop to manipulate time and keep in sync between the server and client. This makes testing easier and more realistic without writing a lot of redundant code.
 
 ## Hyper-trace
 
-Method tracing and conditional break points for Opal and Hyperloop debug.
+Method tracing and conditional break points for Opal and Hyperstack debug.
 
 Typically you are going to use this in Capybara or Opal-RSpec examples that you are debugging.
 
