cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Carlos Santana <csantan...@gmail.com>
Subject Re: Deleting Plugin Docs
Date Fri, 20 Dec 2013 16:38:48 GMT
I'm a bit lost

Is the eventual goal to build the docs as a single website (docs.cordova.io)
with multiple repos cordova-docs repo and plugin repos?



On Fri, Dec 20, 2013 at 11:00 AM, Wargo, John <john.wargo@sap.com> wrote:

> Andrew,
>
> Will you be processing the plugin docs so they generate the pages like
> they used to?  Being able to click and link around within a particular
> plugin's doc is super helpful.
>
> John M. Wargo
> Twitter: @johnwargo
>
>
> -----Original Message-----
> From: agrieve@google.com [mailto:agrieve@google.com] On Behalf Of Andrew
> Grieve
> Sent: Wednesday, December 18, 2013 10:40 PM
> To: dev
> Subject: Fwd: Deleting Plugin Docs
>
> 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
>



-- 
Carlos Santana
<csantana23@gmail.com>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message