From 41bcecf730db6935f4255e331c01a21f3307746c Mon Sep 17 00:00:00 2001 From: dillon Date: Sun, 4 Oct 2015 15:24:08 -0700 Subject: [PATCH] fix assorted problems in docs --- docs/Architecture.md | 2 +- docs/Database.md | 2 +- docs/Debugging.md | 2 +- docs/InterfaceConcepts.md | 4 ++-- docs/PackageOverview.md | 2 +- docs/React.md | 4 ++-- docs/WritingSpecs.md | 2 +- docs/index.md | 6 +++--- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/Architecture.md b/docs/Architecture.md index f45e9a3df..be070ec44 100644 --- a/docs/Architecture.md +++ b/docs/Architecture.md @@ -21,7 +21,7 @@ There are several core stores in the application: - **{DraftStore}**: Manages Drafts, which are {Message} objects the user is authoring. Drafts present a unique case in N1 because they may be updated frequently by disconnected parts of the application. You should use the {DraftStore} to create, edit, and send drafts. -- **{FocusedContentStore}**: Manages focus within the main applciation window. The {FocusedContentStore} allows you to query and monitor changes to the selected thread, tag, file, etc. +- **{FocusedContentStore}**: Manages focus within the main application window. The {FocusedContentStore} allows you to query and monitor changes to the selected thread, tag, file, etc. Most packages declare additional stores that subscribe to these Stores, as well as user Actions, and vend data to the package's React components. diff --git a/docs/Database.md b/docs/Database.md index 67ae19482..977c76fa1 100644 --- a/docs/Database.md +++ b/docs/Database.md @@ -79,7 +79,7 @@ DatabaseStore.count(Thread).where([Thread.attributes.lastMessageTimestamp.greate ## Retrieving Pages of Models -If you need to paginate through a view of data, you should use a `DatabaseView`. Database views can be configured with a sort order and a set of where clauses. After the view is configured, it maintains a cache of models in memory in a highly efficient manner and makes it easy to implement pagination. `DatabaseView` also performs deep inspection of it's cache when models are changed and can avoid costly SQL queries. +If you need to paginate through a view of data, you should use a `DatabaseView`. Database views can be configured with a sort order and a set of where clauses. After the view is configured, it maintains a cache of models in memory in a highly efficient manner and makes it easy to implement pagination. `DatabaseView` also performs deep inspection of its cache when models are changed and can avoid costly SQL queries. ## Saving and Updating Models diff --git a/docs/Debugging.md b/docs/Debugging.md index 828d605be..33beb8673 100644 --- a/docs/Debugging.md +++ b/docs/Debugging.md @@ -41,6 +41,6 @@ If you're debugging a package, you'll be modifying your code and re-running N1 o - **View > Refresh**: From the View menu, choose "Refresh" to reload the N1 window just like a page in your browser. Refreshing is faster than restarting the app and allows you to iterate more quickly. - > Note: A bug in Electron causes the Chromium DevTools to become detatched if you refresh the app often. If you find that Chromium is not stopping at your breakpoints, quit N1 and re-launch it. + > Note: A bug in Electron causes the Chromium DevTools to become detached if you refresh the app often. If you find that Chromium is not stopping at your breakpoints, quit N1 and re-launch it. In the future, we'll support much richer hot-reloading of plugin components and code. Stay tuned! diff --git a/docs/InterfaceConcepts.md b/docs/InterfaceConcepts.md index 8ad46fc14..a08062201 100644 --- a/docs/InterfaceConcepts.md +++ b/docs/InterfaceConcepts.md @@ -10,7 +10,7 @@ The N1 user interface is conceptually organized into Sheets. Each Sheet represen The {WorkspaceStore} maintains the state of the application's workspace and the stack of sheets currently being displayed. Your packages can declare "root" sheets which are listed in the app's main sidebar, or push custom sheets on top of sheets to display data. -The Nylas Workspace supports two display modes: `split` and `list`. Each Sheet describes it's appearance in each of the view modes it supports. For example, the `Threads` sheet describes a three column `split` view and a single column `list` view. Other sheets, like `Files` register for only one mode, and the user's mode preference is ignored. +The Nylas Workspace supports two display modes: `split` and `list`. Each Sheet describes its appearance in each of the view modes it supports. For example, the `Threads` sheet describes a three column `split` view and a single column `list` view. Other sheets, like `Files` register for only one mode, and the user's mode preference is ignored. For each mode, Sheets register a set of column names. @@ -40,7 +40,7 @@ ComponentRegistry.register NotificationsStickyBar, Each column is laid out as a CSS Flexbox, making them extremely flexible. For more about layout using Flexbox, see Working with Flexbox. -###Toolbars +### Toolbars Toolbars in N1 are also powered by the {ComponentRegistry}. Though toolbars appear to be a single unit at the top of a sheet, they are divided into columns with the same widths as the columns in the sheet beneath them. diff --git a/docs/PackageOverview.md b/docs/PackageOverview.md index eb85566db..aca9c04e1 100644 --- a/docs/PackageOverview.md +++ b/docs/PackageOverview.md @@ -46,7 +46,7 @@ Our package also contains source files, a spec file with complete tests for the N1 can read `js`, `coffee`, `jsx`, and `cjsx` files automatically. -Inside `main.coffee`, there are two important functions being exported: +Inside `main.coffee`, there are three important functions being exported: ```coffee require './translate-button' diff --git a/docs/React.md b/docs/React.md index 6dedf5fd9..4f5235e99 100644 --- a/docs/React.md +++ b/docs/React.md @@ -6,7 +6,7 @@ Order: 2 N1 uses [React](https://facebook.github.io/react/) to create a fast, responsive UI. Packages that want to extend the N1 interface should use React. Using React's [JSX](https://facebook.github.io/react/jsx-in-depth.html) syntax is optional, but both [JSX](https://facebook.github.io/react/jsx-in-depth.html) and [CJSX](https://github.com/jsdf/coffee-react) (CoffeeScript) are available. -For a quick introduction to React, take a look at Facebook's [Getting Started with React](https://facebook.github.io/react/getting-started.html). +For a quick introduction to React, take a look at Facebook's [Getting Started with React](http://facebook.github.io/react/docs/getting-started.html). #### React Components @@ -43,7 +43,7 @@ Here's a quick look at standard components you can require from `nylas-component ## React Component Injection -The N1 interface is composed at runtime from components added by different packages. The app's left sidebar contains components from the composer package, the source list package, the activity package, and more. You can leverage the flexiblity of this system to extend almost any part of N1's interface. +The N1 interface is composed at runtime from components added by different packages. The app's left sidebar contains components from the composer package, the source list package, the activity package, and more. You can leverage the flexibility of this system to extend almost any part of N1's interface. ### Registering Components diff --git a/docs/WritingSpecs.md b/docs/WritingSpecs.md index 9d2312be5..1562ade00 100644 --- a/docs/WritingSpecs.md +++ b/docs/WritingSpecs.md @@ -108,7 +108,7 @@ describe "fs.readdir(path, cb)", -> expect(spy).toHaveBeenCalledWith(null, ['example.coffee']) ``` -For a more detailed documentation on asynchronous tests please visit the http://jasmine.github.io/1.3/introduction.html#section-Asynchronous_Support)[Jasmine documentation]. +For a more detailed documentation on asynchronous tests please visit the [Jasmine documentation](http://jasmine.github.io/1.3/introduction.html#section-Asynchronous_Support). #### Tips for Debugging Specs diff --git a/docs/index.md b/docs/index.md index 7a3f877a4..8fdd870a3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -73,7 +73,7 @@ blockquote p {

Start building on top of Nylas in minutes:

1
Install N1

-

Download and install Nylas for . Open it and sign in to your email account.

+

Download and install Nylas for Mac OS X (or Linux). Open it and sign in to your email account.

@@ -117,7 +117,7 @@ blockquote p { -

Step 2: Building your first package

+

Step 3: Building your first package

If you followed the [first part](getting-started) of our Getting Started Guide, you should have a brand new package just waiting to be explored. @@ -238,7 +238,7 @@ If you're a fan of using the Chrome Developer Tools to tinker with styles, no fe
-

Step 3: Adding a Data Store

+

Step 4: Adding a Data Store

Building on the [previous part](getting-started-2) of our Getting Started guide, we're going to introduce a data store to give our sidebar superpowers.