From 677ac96f4f4a2d59ac676611526cb218d91937ba Mon Sep 17 00:00:00 2001 From: Ian Storm Taylor Date: Tue, 12 Jul 2016 22:26:57 -0700 Subject: [PATCH] update docs --- Contributing.md | 18 ++++++++++++++++-- docs/concepts/Readme.md | 1 - examples/index.js | 15 ++++++++------- 3 files changed, 24 insertions(+), 10 deletions(-) diff --git a/Contributing.md b/Contributing.md index 680952951..0d56daba7 100644 --- a/Contributing.md +++ b/Contributing.md @@ -6,7 +6,11 @@ Want to contribute to Slate? That would be awesome! ### Running Tests -To run the examples, you need to have the Slate repository cloned to your computed. After that, you need to `cd` into the directory where you cloned it, and run `make install` to install of its dependencies from `npm`. +To run the examples, you need to have the Slate repository cloned to your computed. After that, you need to `cd` into the directory where you cloned it, and install the dependencies from `npm`. + +``` +make install +``` And then build the source and run the tests: @@ -15,6 +19,12 @@ make dist make test ``` +And to run the linter: + +``` +make lint +``` + If you need to debug something, you can add a `debugger` line to the source, and then run `make test` with the `DEBUG=true` flag enabled. To keep the source rebuilding on every file change, you need to run an additional watching command: @@ -26,7 +36,11 @@ make watch-dist ### Running Examples -To run the examples, you need to have the Slate repository cloned to your computed. After that, you need to `cd` into the directory where you cloned it, and run `make install` to install of its dependencies from `npm`. +To run the examples, you need to have the Slate repository cloned to your computed. After that, you need to `cd` into the directory where you cloned it, and install the dependencies from `npm`. + +``` +make install +``` And then build the source and run the examples server: diff --git a/docs/concepts/Readme.md b/docs/concepts/Readme.md index 24e757a02..d5f7b2a85 100644 --- a/docs/concepts/Readme.md +++ b/docs/concepts/Readme.md @@ -6,7 +6,6 @@ This document explain the core concepts that Slate is built on around. It is hel - [Statelessness & Immutability](./statelessness-and-immutability.md) - [The Document Model](./the-document-model.md) - [The Selection Model](./the-selection-model.md) -- [Transforms](./transforms.md) - [Plugins](./plugins.md) diff --git a/examples/index.js b/examples/index.js index 62dc27660..d46387377 100644 --- a/examples/index.js +++ b/examples/index.js @@ -3,13 +3,6 @@ import React from 'react' import ReactDOM from 'react-dom' import { Router, Route, Link, IndexRedirect, hashHistory } from 'react-router' -/** - * Perf. - */ - -import Perf from 'react-addons-perf' -window.Perf = Perf - /** * Examples. */ @@ -24,6 +17,14 @@ import PlainText from './plain-text' import RichText from './rich-text' import Tables from './tables' +/** + * Perf. + */ + +import Perf from 'react-addons-perf' + +window.Perf = Perf + /** * Define our example app. *