Merge docs repo into this repo: add /docs

.eslintignore

@@ -2,3 +2,4 @@ dist
 build
 coverage
 node_modules
+docs/public

.eslintrc.js

@@ -1,4 +1,5 @@
 module.exports = {
+  root: true,
   extends: [
     './node_modules/eslint-config-airbnb-base/rules/es6.js',
   ],

.gitignore

@@ -13,3 +13,4 @@ build
 packages/examples/automated-*
 yarn.lock
 /**/LICENSE
+docs/public

.remarkrc

@@ -0,0 +1,16 @@
+{
+  "plugins": [
+    "remark-preset-lint-recommended",
+    ["remark-lint-list-item-indent", false],
+    ["remark-lint-code", {"js": {
+      "module": "node_modules/remark-lint-code-eslint",
+      "options": {
+        "fix": true
+      }
+    }}],
+    ["remark-toc", {
+      "tight": true,
+      "maxDepth": 3
+    }]
+  ]
+}

.travis.yml

@@ -11,7 +11,8 @@ before_install: ./scripts/travis/before_install.sh
 after_success: ./scripts/travis/after_success.sh
 script:
   - npm run bootstrap
-  - lerna exec --scope test-cra  -- npm i
+  - npm run bootstrap:test-cra
+  - npm run bootstrap:docs
   - npm run lint
   - npm run test -- --coverage
   - npm run coverage

CONTRIBUTING.md

@@ -8,37 +8,33 @@ Please review this document to help to streamline the process and save everyone'
 
 No software is bug free. So, if you got an issue, follow these steps:
 
-* Search the [issue list](https://github.com/storybooks/storybook/issues?utf8=%E2%9C%93&q=) for current and old issues.
-* If non of that is helping, create an issue with with following information:
-  * Clear title (make is shorter if possible).
-  * Describe the issue in clear language.
-  * Share error logs, screenshots and etc.
-  * To speed up the issue fixing process, send us a sample repo with the issue you faced:
+-   Search the [issue list](https://github.com/storybooks/storybook/issues?utf8=%E2%9C%93&q=) for current and old issues.
+-   If non of that is helping, create an issue with with following information:
+    -   Clear title (make is shorter if possible).
+    -   Describe the issue in clear language.
+    -   Share error logs, screenshots and etc.
+    -   To speed up the issue fixing process, send us a sample repo with the issue you faced:
 
 ### Testing against `master`
 
 To test your project against the current latest version of storybook, you can clone the repository and link it with `npm`. Try following these steps:
 
-1. Download the latest version of this project, and build it
+1.  Download the latest version of this project, and build it
 
-  ```
-  git clone https://github.com/storybooks/storybook.git
-  cd storybook
-  npm install
-  npm run bootstrap
-  ```
+        git clone https://github.com/storybooks/storybook.git
+        cd storybook
+        npm install
+        npm run bootstrap
 
-2. Link `storybook` and any other required dependencies
+2.  Link `storybook` and any other required dependencies
 
-  ```
-  cd packages/react-storybook
-  npm link
+        cd packages/react-storybook
+        npm link
 
-  cd <your-project>
-  npm link @kadira/storybook
+        cd <your-project>
+        npm link @kadira/storybook
 
-  # repeat with whichever other parts of the monorepo you are using.
-  ```
+        # repeat with whichever other parts of the monorepo you are using.
 
 ### Reproductions
 
@@ -68,18 +64,18 @@ git remote add <your-username> https://github.com/<your-username>/storybook.git
 git push -u <your-username> master
 ```
 
-If you follow that process, you can then link to the github repository in the issue. See https://github.com/storybooks/storybook/issues/708#issuecomment-290589886 for an example.
+If you follow that process, you can then link to the github repository in the issue. See <https://github.com/storybooks/storybook/issues/708#issuecomment-290589886> for an example.
 
-**NOTE**: If your issue involves a webpack config, create-react-app will prevent you from modifying the *app's* webpack config, however you can still modify storybook's to mirror your app's version of storybook. Alternatively, use `npm run eject` in the CRA app to get a modifiable webpack config.
+**NOTE**: If your issue involves a webpack config, create-react-app will prevent you from modifying the _app's_ webpack config, however you can still modify storybook's to mirror your app's version of storybook. Alternatively, use `npm run eject` in the CRA app to get a modifiable webpack config.
 
 ## Pull Requests (PRs)
 
 We welcome your contributions. There are many ways you can help us. This is few of those ways:
 
-* Fix typos and add more [documentation](https://github.com/storybooks/storybook/labels/needs%20docs).
-* Try to fix some [bugs](https://github.com/storybooks/storybook/labels/bug).
-* Work on [API](https://github.com/storybooks/storybook/labels/enhancement%3A%20api), [Addons](https://github.com/storybooks/storybook/labels/enhancement%3A%20addons), [UI](https://github.com/storybooks/storybook/labels/enhancement%3A%20ui) or [Webpack](https://github.com/storybooks/storybook/labels/enhancement%3A%20webpack) use enhancements and new [features](https://github.com/storybooks/storybook/labels/feature%20request).
-* Add more [tests](https://codecov.io/gh/storybooks/storybook/tree/master/packages) (specially for the [UI](https://codecov.io/gh/storybooks/storybook/tree/master/packages/storybook-ui/src)).
+-   Fix typos and add more [documentation](https://github.com/storybooks/storybook/labels/needs%20docs).
+-   Try to fix some [bugs](https://github.com/storybooks/storybook/labels/bug).
+-   Work on [API](https://github.com/storybooks/storybook/labels/enhancement%3A%20api), [Addons](https://github.com/storybooks/storybook/labels/enhancement%3A%20addons), [UI](https://github.com/storybooks/storybook/labels/enhancement%3A%20ui) or [Webpack](https://github.com/storybooks/storybook/labels/enhancement%3A%20webpack) use enhancements and new [features](https://github.com/storybooks/storybook/labels/feature%20request).
+-   Add more [tests](https://codecov.io/gh/storybooks/storybook/tree/master/packages) (specially for the [UI](https://codecov.io/gh/storybooks/storybook/tree/master/packages/storybook-ui/src)).
 
 Before you submit a new PR, make you to run `npm test`. Do not submit a PR if tests are failing. If you need any help, create an issue and ask.
 
@@ -102,9 +98,10 @@ Issues that are tagged `question / support` or `needs reproduction` are great pl
 Once you've helped out on a few issues, if you'd like triage access you can help label issues and respond to reporters.
 
 We use the following label scheme to categorize issues:
-- **type** - `bug`, `feature`, `question / support`, `discussion`, `greenkeeper`, `maintenance`.
-- **area** - `addon: x`, `addons-api`, `stories-api`, `ui`, etc.
-- **status** - `needs reproduction`, `needs PR`, `in progress`, etc.
+
+-   **type** - `bug`, `feature`, `question / support`, `discussion`, `greenkeeper`, `maintenance`.
+-   **area** - `addon: x`, `addons-api`, `stories-api`, `ui`, etc.
+-   **status** - `needs reproduction`, `needs PR`, `in progress`, etc.
 
 All issues should have a `type` label. `bug`/`feature`/`question`/`discussion` are self-explanatory. `greenkeeper` is for keeping package dependencies up to date. `maintenance` is a catch-all for any kind of cleanup or refactoring.
 
@@ -116,17 +113,17 @@ If an issue is a `bug`, and it doesn't have a clear reproduction that you have p
 
 ### Closing issues
 
-- Duplicate issues should be closed with a link to the original.
+-   Duplicate issues should be closed with a link to the original.
 
-- Unreproducible issues should be closed if it's not possible to reproduce them (if the reporter drops offline, it is reasonable to wait 2 weeks before closing).
+-   Unreproducible issues should be closed if it's not possible to reproduce them (if the reporter drops offline, it is reasonable to wait 2 weeks before closing).
 
-- `bug`s should be labeled `merged` when merged, and be closed when the issue is fixed and released.
+-   `bug`s should be labeled `merged` when merged, and be closed when the issue is fixed and released.
 
-- `feature`s, `maintenance`s, `greenkeeper`s should be labeled `merged` when merged, and closed when released or if the feature is deemed not appropriate.
+-   `feature`s, `maintenance`s, `greenkeeper`s should be labeled `merged` when merged, and closed when released or if the feature is deemed not appropriate.
 
-- `question / support`s should be closed when the question has been answered. If the questioner drops offline, a reasonable period to wait is two weeks.
+-   `question / support`s should be closed when the question has been answered. If the questioner drops offline, a reasonable period to wait is two weeks.
 
-- `discussion`s should be closed at a maintainer's discretion.
+-   `discussion`s should be closed at a maintainer's discretion.
 
 ## Development Guide
 
@@ -135,9 +132,7 @@ If an issue is a `bug`, and it doesn't have a clear reproduction that you have p
 This project written in ES2016+ syntax so, we need to transpile it before use.
 So run the following command:
 
-```
-npm run dev
-```
+    npm run dev
 
 This will watch files and transpile.
 

HISTORY.md

@@ -1,6 +1,6 @@
 ## v.Next
 
-- Deprecated `{ linkTo, action }` as built-in addons: https://github.com/storybooks/storybook/issues/1017. From 3.0 use them as you would [any other addon](https://storybooks.js.org/docs/react-storybook/addons/using-addons/).
+-   Deprecated `{ linkTo, action }` as built-in addons: <https://github.com/storybooks/storybook/issues/1017>. From 3.0 use them as you would [any other addon](https://storybooks.js.org/docs/react-storybook/addons/using-addons/).
 
 Before:
 

README.md

@@ -1,13 +1,14 @@
 # Storybook
+
 [![Greenkeeper badge](https://badges.greenkeeper.io/storybooks/storybook.svg)](https://greenkeeper.io/)
 [![Build Status](https://travis-ci.org/storybooks/storybook.svg?branch=master)](https://travis-ci.org/storybooks/storybook)
 [![CodeFactor](https://www.codefactor.io/repository/github/storybooks/storybook/badge)](https://www.codefactor.io/repository/github/storybooks/storybook)
 [![Known Vulnerabilities](https://snyk.io/test/github/storybooks/storybook/8f36abfd6697e58cd76df3526b52e4b9dc894847/badge.svg)](https://snyk.io/test/github/storybooks/storybook/8f36abfd6697e58cd76df3526b52e4b9dc894847)
-[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)  
+[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)
 [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/)
 [![Backers on Open Collective](https://opencollective.com/storybook/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/storybook/sponsors/badge.svg)](#sponsors)
 
----
+* * *
 
 Storybook is a development environment for UI components.
 It allows you to browse a component library, view the different states of each component, and interactively develop and test components.
@@ -20,10 +21,23 @@ Storybook runs outside of your app. This allows you to develop UI components in
 
 Storybook comes with a lot of [addons](https://storybooks.js.org/docs/react-storybook/addons/introduction) for component design, documentation, testing, interactivity, and so on. Storybook's easy-to-use API makes it easy to configure and extend in various ways. It has even been extended to support React Native development for mobile.
 
+## Table of contents
+
+-   [Getting Started](#getting-started)
+-   [Projects](#projects)
+    -   [Main Projects](#main-projects)
+    -   [Sub Projects](#sub-projects)
+    -   [Addons](#addons)
+-   [Contributing](#contributing)
+    -   [Development scripts](#development-scripts)
+    -   [Backers](#backers)
+    -   [Sponsors](#sponsors)
+
 ## Getting Started
 
 First install storybook:
-```js
+
+```sh
 npm i -g @storybook/cli
 cd my-react-app
 getstorybook
@@ -36,32 +50,61 @@ For full documentation on using Storybook visit: [storybooks.js.org](https://sto
 ## Projects
 
 ### Main Projects
-- [Storybook for react](app/react) - Storybook for React components
-- [Storybook for react-native](app/react-native) - Storybook for React components
+
+-   [Storybook for react](app/react) - Storybook for React components
+-   [Storybook for react-native](app/react-native) - Storybook for React components
 
 ### Sub Projects
-- [CLI](lib/cli) - Streamlined installation for a variety of app types
-- [examples](examples) - Code examples to illustrate different Storybook use cases
+
+-   [CLI](lib/cli) - Streamlined installation for a variety of app types
+-   [examples](examples) - Code examples to illustrate different Storybook use cases
 
 ### Addons
-- [addon-storyshots](addons/storyshots) - Easy snapshot testing for storybook
-- [addon-actions](addons/actions/) - Log actions as users interact with components in storybook
-- [addon-comments](addons/comments/) - Comment on storybook stories
-- [addon-graphql](addons/graphql/) - Query a GraphQL server within Storybook stories
-- [addon-info](addons/info/) - Annotate stories with extra component usage information
-- [addon-knobs](addons/knobs/) - Interactively edit component prop data in the Storybook UI
-- [addon-notes](addons/notes/) - Annotate storybook stories with notes
-- [addon-options](addons/options/) - Customize the storybook UI in code
+
+-   [storyshots](addons/storyshots) - Easy snapshot testing for storybook
+-   [actions](addons/actions/) - Log actions as users interact with components in storybook
+-   [comments](addons/comments/) - Comment on storybook stories
+-   [graphql](addons/graphql/) - Query a GraphQL server within Storybook stories
+-   [info](addons/info/) - Annotate stories with extra component usage information
+-   [knobs](addons/knobs/) - Interactively edit component prop data in the Storybook UI
+-   [notes](addons/notes/) - Annotate storybook stories with notes
+-   [options](addons/options/) - Customize the storybook UI in code
 
 ## Contributing
 
 We welcome contributions to Storybook! There are many ways to contribute to
 this project. [Get started here](CONTRIBUTING.md)
 
+### Development scripts
+
+#### `npm run bootstrap`
+
+> Installs package dependencies and links packages together - using lerna
+
+#### `npm run publish`
+
+> Push a release to git and npm
+> will ask for version in interactive mode - using lerna.
+
+#### `npm run lint`
+
+> boolean check if code conforms to linting rules - uses remark & eslint
+
+-   `npm run lint:js` - will check js
+-   `npm run lint:markdown` - will check markdown + code samples
+
+-   `npm run lint:js -- --fix` - will autofix js
+-   `npm run lint:markdown -- -o` - will autofix markdown
+
+#### `npm run test`
+
+> boolean check if unittests all pass - uses jest
+
+-   `npm run test:watch` - will run tests in watchmode
 
 ### Backers
 
-Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/storybook#backer)]
+Support us with a monthly donation and help us continue our activities. \[[Become a backer](https://opencollective.com/storybook#backer)]
 
 <a href="https://opencollective.com/storybook/backer/0/website" target="_blank"><img src="https://opencollective.com/storybook/backer/0/avatar.svg"></a>
 <a href="https://opencollective.com/storybook/backer/1/website" target="_blank"><img src="https://opencollective.com/storybook/backer/1/avatar.svg"></a>
@@ -94,10 +137,9 @@ Support us with a monthly donation and help us continue our activities. [[Become
 <a href="https://opencollective.com/storybook/backer/28/website" target="_blank"><img src="https://opencollective.com/storybook/backer/28/avatar.svg"></a>
 <a href="https://opencollective.com/storybook/backer/29/website" target="_blank"><img src="https://opencollective.com/storybook/backer/29/avatar.svg"></a>
 
-
 ### Sponsors
 
-Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/storybook#sponsor)]
+Become a sponsor and get your logo on our README on Github with a link to your site. \[[Become a sponsor](https://opencollective.com/storybook#sponsor)]
 
 <a href="https://opencollective.com/storybook/sponsor/0/website" target="_blank"><img src="https://opencollective.com/storybook/sponsor/0/avatar.svg"></a>
 <a href="https://opencollective.com/storybook/sponsor/1/website" target="_blank"><img src="https://opencollective.com/storybook/sponsor/1/avatar.svg"></a>
@@ -129,4 +171,3 @@ Become a sponsor and get your logo on our README on Github with a link to your s
 <a href="https://opencollective.com/storybook/sponsor/27/website" target="_blank"><img src="https://opencollective.com/storybook/sponsor/27/avatar.svg"></a>
 <a href="https://opencollective.com/storybook/sponsor/28/website" target="_blank"><img src="https://opencollective.com/storybook/sponsor/28/avatar.svg"></a>
 <a href="https://opencollective.com/storybook/sponsor/29/website" target="_blank"><img src="https://opencollective.com/storybook/sponsor/29/avatar.svg"></a>
-

addons/actions/CHANGELOG.md

@@ -1,39 +1,43 @@
 ## Changelog
 
 ### v1.1.3
+
 22 Mar 2017
 
-* Fix issue caused by `v1.1.2` where storybook crashes when actions are used without names [PR30](https://github.com/storybooks/storybook-addon-actions/pull/30).
+-   Fix issue caused by `v1.1.2` where storybook crashes when actions are used without names [PR30](https://github.com/storybooks/storybook-addon-actions/pull/30).
 
 ### v1.1.2
+
 21 Mar 2017
 
-* Document `decorateAction` function (action decorator). [PR28](https://github.com/storybooks/storybook-addon-actions/pull/28)
+-   Document `decorateAction` function (action decorator). [PR28](https://github.com/storybooks/storybook-addon-actions/pull/28)
 
-* Set correct Function.name for action handlers [PR24](https://github.com/storybooks/storybook-addon-actions/pull/24)
+-   Set correct Function.name for action handlers [PR24](https://github.com/storybooks/storybook-addon-actions/pull/24)
 
 ### v1.1.1
+
 11 Sep 2016
 
-* Support arguments with circular references [PR6](https://github.com/kadirahq/storybook-addon-actions/pull/6)
+-   Support arguments with circular references [PR6](https://github.com/kadirahq/storybook-addon-actions/pull/6)
 
 ### v1.1.0
+
 11 Sep 2016
 
-* Support action decorators [PR3](https://github.com/kadirahq/storybook-addon-actions/pull/3)
+-   Support action decorators [PR3](https://github.com/kadirahq/storybook-addon-actions/pull/3)
 
 ### v1.0.4
 
-* Refactor source code (use separate files)
+-   Refactor source code (use separate files)
 
 ### v1.0.3
 
-* Log all arguments (only the first argument was logged previously)
+-   Log all arguments (only the first argument was logged previously)
 
 ### v1.0.2
 
-* Style tweak: center counter and inspector elements
+-   Style tweak: center counter and inspector elements
 
 ### v1.0.1
 
-* First stable release with all features from the storybook action logger such as `action` function, react inspector and grouping log messages.
+-   First stable release with all features from the storybook action logger such as `action` function, react inspector and grouping log messages.

addons/actions/README.md

@@ -1,4 +1,5 @@
 # Storybook Addon Actions
+
 [![Greenkeeper badge](https://badges.greenkeeper.io/storybooks/storybook.svg)](https://greenkeeper.io/)
 [![Build Status](https://travis-ci.org/storybooks/storybook.svg?branch=master)](https://travis-ci.org/storybooks/storybook)
 [![CodeFactor](https://www.codefactor.io/repository/github/storybooks/storybook/badge)](https://www.codefactor.io/repository/github/storybooks/storybook)
@@ -20,7 +21,7 @@ You can use this addon without installing it manually.
 
 Import the `action` function and use it to create actions handlers. When creating action handlers, provide a **name** to make it easier to identify.
 
-> *Note: Make sure NOT to use reserved words as function names. [issues#29](https://github.com/storybooks/storybook-addon-actions/issues/29#issuecomment-288274794)*
+> _Note: Make sure NOT to use reserved words as function names. [issues#29](https://github.com/storybooks/storybook-addon-actions/issues/29#issuecomment-288274794)_
 
 ```js
 import { storiesOf } from '@storybook/react'