Skip to content

Commit

Permalink
updating the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jfyles committed Jan 21, 2018
1 parent 8c7f4f5 commit 1726536
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 28 deletions.
3 changes: 1 addition & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
title: Air Traffic Control
email: [email protected]
description: >
Jekyll Template for Project Websites
providing documentation and blog post pages.
Air Traffic Control is a router for Redux that keeps your routes and actions in sync.
baseurl: "/air-traffic-control" # the subpath of your site
url: https://airplane-mode.github.io/air-traffic-control # the base hostname & protocol for your site
Expand Down
37 changes: 20 additions & 17 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<div class="container">
<h1>Dead Simple Redux Routing</h1>
<p>
Air Traffic Control is the redux router you've been waiting for. It lets you keep all of your routes in one place and map them directly to redux actions so you can keep routing logic from getting scattered across your views.
Air Traffic Control is the Redux router you've been waiting for. It lets you keep all of your routes in one place and map them directly to Redux actions so you can keep routing logic from getting scattered across your views.
</p>
<p><a class="btn btn-primary btn-lg" href="{{ "/docs/home/" | prepend: site.baseurl }}" role="button">Learn more</a></p>
</div>
Expand All @@ -17,13 +17,11 @@ <h1>Dead Simple Redux Routing</h1>

<div class="row">
<div class="col-md-6">
<h2 class="header-light regular-pad">Why another react/redux router?</h2>
<h2 class="header-light regular-pad">Why another React/Redux router?</h2>
<blockquote>
<p>
First of all, Air Traffic Control is a redux router, not a react router. It works great with react, but it also works equally well <strong>without</strong> react. We believe libraries are best when it requires minimal ecosystem buy-in, and does one thing well.
<br/><br/>
There are certainly lots of options out there for routers, but none of them something something something.
</p>
<p>
Route changes are actions, just like mouse clicks. They should be handled the same way, and they should certainly be kept out of your views. We believe that all of the existing routers for React/Redux treat route changes wrong, and Air Traffic Control aims to fix that.
</p>
</blockquote>
</div>
<div class="col-md-6 text-center">
Expand All @@ -35,23 +33,28 @@ <h2 class="header-light regular-pad">Why another react/redux router?</h2>

<div class="row">
<div class="col-sm-4">
<h1 class="text-center"><i class="fa fa-code" aria-hidden="true"></i></h1>
<h3 class="text-center">Easy to integrate</h3>
<p>Get started by cloning source into GitHub account of your project. Thanks to <a href="https://pages.github.com">GitHub Pages</a>,
it will be automatically compiled and published under your project's subdomain on `github.io`.
<h1 class="text-center"><i class="fa fa-cogs" aria-hidden="true"></i></h1>
<h3 class="text-center">Works with any Redux application</h3>
<p>
Air Traffic Control is a Redux router, not a React router. It works great with React, but it also works equally well <strong>without</strong> React. We believe libraries are best when they require minimal ecosystem buy-in, and do one thing well.
</p>
</div>
<div class="col-sm-4">
<h1 class="text-center"><i class="fa fa-cogs" aria-hidden="true"></i></h1>
<h3 class="text-center">Modular Styling and Templating</h3>
<p>This template uses <a href="https://github.com/twbs/bootstrap-sass">bootstrap-sass</a> along with <a href="https://bootswatch.com/">Bootwatch themes</a>.
You can change the theme or write your custom by overwriting bootstrap sass variables for a different color set, font options, etc.</p>
<h3 class="text-center">Encourages separation of concerns</h3>
<p>
The biggest drawback to most React applications is that they eschew separation of concerns by co-locating layout, styling, and routing in their views. We believe this maximizes lock-in and minimizes ability to scale. With Air Traffic Control, you can put your routes wherever you want, and they don't need to match up 1:1 with your views.
</p>
</div>
<div class="col-sm-4">
<h1 class="text-center"><i class="fa fa-code-fork" aria-hidden="true"></i></h1>
<h3 class="text-center">Git-based source control</h3>
<p>Leverage from Git version control system by
maintaining your documentation along with the source code; publish the page when you merge to the master branch.</p>
<h3 class="text-center">Action-based</h3>
<p>
A Redux action can change the route. A route can fire a Redux action. Air Traffic Control can even intercept all of the same-domain links in your app so they fire actions instead of just hiding and showing components.
</p>
<p>
That means you don’t need to preload all of the data in your Redux app's initial load.
<p>
</div>
</div>

Expand Down
18 changes: 9 additions & 9 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 1726536

Please sign in to comment.