Github user nikhilkh commented on a diff in the pull request: https://github.com/apache/cordova-docs/pull/527#discussion_r54623053 --- Diff: www/_posts/2016-02-29-docs-improvement.md --- @@ -0,0 +1,31 @@ +--- +layout: post +author: + name: Raghav Katyal + url: https://github.com/rakatyal +title: "Docs Improvement" +categories: announcements +tags: news releases docs +--- + +We are happy to announce that we have made significant content updates to our documentation. +<!--more--> + +A while back we conducted a [survey](https://apachecordovabot.typeform.com/to/BCc5co) on the Cordova website asking for the experience of working with Cordova from our users. We received more than 900 responses and Documentation emerged as one of the major pain points of an average Cordova developer. + +Since then we have made efforts to improve the quality of our documentation. To summarize it: + +- Validated and corrected most of the current doc content. +- Re-organized the content for our website and made our table of contents more concise and composed of action driven items for ease of navigation. +- Added a 'Reference' section and updated the articles to make them comprehensive and reader friendly. [CLI](http://cordova.apache.org/docs/en/latest/cordova-cli/index.html) for example, now lives under the 'Reference' section. +- Updated the platform guides as single page content following a common structure. --- End diff -- Great to give an example here too. For example, the [Android guide](http://link) has important details on machine setup - blah blah. (highlighting the common structure).
--- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. --- --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@cordova.apache.org For additional commands, e-mail: dev-h...@cordova.apache.org