Splitting out the docs would be really tough for some things: - cross-cutting: "Platform support", "Icons & Splashscreens" - Generic in nature: "Privacy Guide", "Security Guide", etc
Handling translations is also a pain the more we extract things out. Having CLI create pre-project docs is a neat idea, but online is where people look. So.... I think I've warmed up to the idea of generating new docs for each CLI release. For platform-specific things, we'll still need to say when features are introduced though, since updating your CLI doesn't mean you've updating your platforms. I think we'll need to have our docs generation de-dupe images assets instead of creating copies for each version / language since that's 99% of the file size in the repo. On Wed, Aug 20, 2014 at 9:59 PM, Carlos Santana <csantan...@gmail.com> wrote: > Yes Ray, that's what I meant as a new Design for the Docs website. To be a > consolidated simple view of the docs, but the real docs will be associated > with each component as an implementation detail. > > It can also be a consolidated view of docs as utility of the cordova CLI, > for example "$cordova docs" launches a local web server, open the browser, > and serves a local website with the content coming form the versions of the > things being used in your cordova project/folder (ios, plugin1, plugin2) > > We need to try different things, get feedback and iterate > > And feedback from coming form developers such as yourself. > > --Carlos > > > > > On Wed, Aug 20, 2014 at 8:58 PM, Ray Camden <rayca...@adobe.com> wrote: > >> Keep in mind - the average developer probably has no idea what >> cordova-ios, cordova-cli, and cordova-lib means. They npm install cordova, >> and to them, that's it. >> ________________________________________ >> From: Carlos Santana <csantan...@gmail.com> >> Sent: Wednesday, August 20, 2014 7:54 PM >> To: dev@cordova.apache.org >> Subject: Re: What's Stopping us From Independent Platform Releases >> >> I think we need to come down to the same conclusion as we did for plugins. >> The documentation for each "component" meaning "cordova-ios", >> "cordova-cli", "cordova-lib" needs to live with it's repo/code and version >> together. >> >> The remaining things can be left in cordova-docs that are independent of a >> version of a component to an extent like security guide. >> >> The Cordova Docs Website will need to have a new UX design to make sense of >> where links point and somehow allow the user know what's the latest release >> and the different components with each respective version. >> >> >> > > > -- > Carlos Santana > <csantan...@gmail.com>
