Sounds great!
On Wed, Aug 7, 2013 at 8:27 PM, Michael Brooks wrote:
> Thanks for kicking this off Andrew.
>
> As Brian mentioned, we've now gone some cycles to work on this problem and
> I'd be happy to lead it forward.
>
> I'll put together a *cringe* wiki article *cringe* summarizing the goals
Thanks for kicking this off Andrew.
As Brian mentioned, we've now gone some cycles to work on this problem and
I'd be happy to lead it forward.
I'll put together a *cringe* wiki article *cringe* summarizing the goals
forward, but here is the breakdown that I see:
Plugins should bundle their own
yes, exactly so, and it separates the concern of documenting vs
publishing meaning we can experiment w/ the publishing side without
getting caught w/ our docs lagging behind
On Wed, Aug 7, 2013 at 11:04 AM, Braden Shepherdson wrote:
> +1 to that folder structure, especially with the languages. Pl
+1 to that folder structure, especially with the languages. Plugins come
with up-to-date documentation; no need to insert separate versions here.
Git can handle the versioning better than having separate directories.
Braden
On Wed, Aug 7, 2013 at 10:08 AM, Michal Mocny wrote:
> I like that fol
I like that folder structure.
On Wed, Aug 7, 2013 at 12:35 PM, Brian LeRoux wrote:
> Ya, we were just discussing this in Adobe land. The current idea is
> that a plugin has a ./docs/ folder which contains all the markdown and
> *possibly* a config file.
>
> Something like this:
>
> ./plugin-wha
Ya, we were just discussing this in Adobe land. The current idea is
that a plugin has a ./docs/ folder which contains all the markdown and
*possibly* a config file.
Something like this:
./plugin-whatever
|-docs/
| |-en/
...
And then we'd have a viewer/transformer code and deal w/ publishing
I'd like to see docs and tests moved into the plugin repos eventually,
with us putting work into our tools to support documentation and testing
workflows.
How that all shakes out still has to be determined :)
Hopefully that will end up encouraging plugin authors to write docs/tests
:)
On 8/7/13
+1 to README bundled with the plugin, and having a `cordova docs`, so that
we can have offline documentation.
I would also like a way to have the guides available offline, but perhaps
that could come in the form of a cordova-plugin-guides or come bundled with
cordova-cli and be included with every
If we're releasing plugins independently (which is great!), then it doesn't
make sense to have all of our plugin APIs documented as one, and under the
same parent version.
e.g. Right now we have: docs/3.0/File , docs/3.0/InAppBrowser, etc.
One option is to switch away from having the version as t
