cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwbro...@apache.org
Subject [5/6] docs commit: [CB-3962] Removed unnecessary subheads.
Date Mon, 15 Jul 2013 17:58:04 GMT
[CB-3962] Removed unnecessary subheads.


Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/925f8e97
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/925f8e97
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/925f8e97

Branch: refs/heads/master
Commit: 925f8e97c5c07bb5d778f6b4b22250b18aaf2c96
Parents: 2380642
Author: Mike Sierra <letmespellitoutforyou@gmail.com>
Authored: Mon Jul 15 12:48:25 2013 -0400
Committer: Michael Brooks <michael@michaelbrooks.ca>
Committed: Mon Jul 15 10:56:24 2013 -0700

----------------------------------------------------------------------
 STYLESHEET.md                                      | 17 ++++++++++++++---
 docs/en/edge/cordova/file/filewriter/filewriter.md |  4 ++--
 2 files changed, 16 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/925f8e97/STYLESHEET.md
----------------------------------------------------------------------
diff --git a/STYLESHEET.md b/STYLESHEET.md
index 2dd9f68..96846da 100644
--- a/STYLESHEET.md
+++ b/STYLESHEET.md
@@ -44,6 +44,17 @@ editorial guidelines.
 
 * Do not combine in-line formatting such as _`monospace italic`_.
 
+## Structure
+
+* Flatten text wherever possible. Avoid nested lists. Avoid
+  third-level subheadings.
+
+* Do not follow a heading with a subheading or a list with no
+  intervening text.
+
+* Avoid too many NOTEs, as it implies too many variables that can go
+  wrong. Try to clarify variations on a procedure within the text.
+
 ## Language and Tone
 
 * Use present tense. "This happens," not "this will happen." (Future
@@ -86,9 +97,6 @@ editorial guidelines.
   include either, remove spaces around the dashes (punctuate fragments
   outside of paren's). (Punctuate full sentences inside of parens.)
 
-* Avoid too many NOTEs, as it implies too many variables that can go
-  wrong. Try to clarify variations on a procedure within the text.
-
 ## Usage
 
 * "User" may refer to the end user, not to the application's
@@ -133,6 +141,9 @@ editorial guidelines.
 
 ## Punctuation
 
+* Initial Cap Words in Headings, Except for Short Prepositions or
+  Conjunctions
+
 * Append colon to text that introduces a code snippet, image, or
   procedure listing.
 

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/925f8e97/docs/en/edge/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filewriter/filewriter.md b/docs/en/edge/cordova/file/filewriter/filewriter.md
index 2269c06..87d542e 100644
--- a/docs/en/edge/cordova/file/filewriter/filewriter.md
+++ b/docs/en/edge/cordova/file/filewriter/filewriter.md
@@ -67,12 +67,12 @@ Text data is supported by all platforms listed below. Text is encoded
as UTF-8 b
 Supported Platforms
 -------------------
 
-### Text and Binary suport
+Text and Binary Support:
 
 - Android
 - iOS
 
-### Text only support
+Text-only Support:
 
 - BlackBerry WebWorks (OS 5.0 and higher)
 - Windows Phone 7 and 8


Mime
View raw message