Mailing-List: contact dev-help@cordova.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@cordova.apache.org
Received-SPF: pass (nike.apache.org: domain of mikeywbrooks@gmail.com
 designates 209.85.212.169 as permitted sender)
MIME-Version: 1.0
Sender: mikeywbrooks@gmail.com
In-Reply-To: 
 <CABiQX1XGf7To3kuZGjAgg5LO4_8pWpAp3YmRkgBUf6LAH3K1Xw@mail.gmail.com>
References: 
 <CABiQX1WNE3kZuDhO9aHGTRrNSSC0arwXxfLvwoP23GrEEn0CGA@mail.gmail.com>
	<CAOe3-e6+Tt74zi0x9--N_czJmH-D+7KSzK6zwuDFhVFbZMZ04g@mail.gmail.com>
	<CAEeF2TdZKQUqXFJw_Miy13BZ3PkN1JnX2NgY-TVwpq2AQE3V_w@mail.gmail.com>
	<CAEeF2Tdj8wLMKJuXiXTY_CtRussqDM-PmUJ7dXh2zTBQ1CgbGg@mail.gmail.com>
	<CABiQX1V-JFiYgzV8wzbh04C0yjtWy1LWdtD8cTvzQJ--5tK+Ww@mail.gmail.com>
	<CADVgkyOB0OfKS4g0ywYebkqeOiSvjW1HR7V-kSMGN_NirMjF7g@mail.gmail.com>
	<CAP7NMPrjeHB5-Yd02yvHwmkzdDazZu6gTyBCbQvu2bDmWAg93Q@mail.gmail.com>
	<52EFFE29-B85B-4C3E-BB2F-15CD4D415CC1@gmail.com>
	<CABiQX1VdWBtXCWHwVz21vqLi1SDAe3qSv19VAmEaPBfjm83GxQ@mail.gmail.com>
	<CAP7NMPqF7uiwBqCseKTAwvQhsK7j7WkbYeMzJThp8OqkxW0A8g@mail.gmail.com>
	<CABiQX1X4pLgVvouGG59WOjgspJX2s-s9vGbjC_9Kbis2EUgYVg@mail.gmail.com>
	<CABiQX1Ukt4Daim1Pyi0sTaJuNMtnoVSiDSSDz+geR=s23-H1rg@mail.gmail.com>
	<CABiQX1XGf7To3kuZGjAgg5LO4_8pWpAp3YmRkgBUf6LAH3K1Xw@mail.gmail.com>
Date: Thu, 19 Dec 2013 13:00:18 -0800
Message-ID: 
 <CAP7NMPqG++QouTmRrzEzrhaNjCmAP7xdVD6Gkn5RHpZanM=LJw@mail.gmail.com>
Subject: Re: Deleting Plugin Docs
From: Michael Brooks <michael@michaelbrooks.ca>
To: "dev@cordova.apache.org" <dev@cordova.apache.org>
Content-Type: text/plain; charset=ISO-8859-1

Nice Andrew.

I think the "Plugins API" page is a good start. We can iterate on it
to improve the experience.

Personally, I would rather not have cut out the quick examples, full
examples, etc. Some of the most positive feedback for our
documentation is that it's thorough and copy & paste ready. This helps
to get people up and running quickly. Just my two cents.

I am very hesitant about removing the File API documentation and
linking to external sources. When files become too large - similar to
functions - we use multiple files. In the past, we've found that the
W3C spec or external documentation (e.g. File API used by certain
browsers) is a moving target. How confident are we that the Cordova
File API will be a 100% match to the HTML 5 Rocks documentation?

Michael

On Wed, Dec 18, 2013 at 7:39 PM, Andrew Grieve <agrieve@chromium.org> wrote:
> This is now done! Woo! No more having plugins code separate from their docs
> (I hear we might even get tests to live within plugin repos in the next
> while too!).
>
> I tried to be diligent, but it's possible I made mistakes along the way.
> You can see the result on the edge version of the docs:
> http://cordova.apache.org/docs/en/edge/
>
> There's a new "Plugins API" page, and all of the plugin docs are moved into
> the respective repos within a doc/index.md file.
>
> Some of doc/index.md files are fairly large, and to help with that I
> attempted to remove some of the repetition that I found: Quick Examples vs.
> Full Examples, Overviews vs Descriptions (in cases where they were saying
> the same thing).
>
> Also - for the file API, I just wrote to refer to the FileSystem spec for
> the API and copied over only the Cordova platform quirks. This will be a
> bad offline experience, so I'm not 100% convinced that was the right thing
> to do, but wow is that file big if you were to copy over all of the
> documentation!
>
> https://github.com/apache/cordova-plugin-file/blob/dev/doc/index.md