cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nikhilkh <...@git.apache.org>
Subject [GitHub] cordova-docs pull request: Adding blog post for docs improvement
Date Tue, 01 Mar 2016 19:52:25 GMT
Github user nikhilkh commented on a diff in the pull request:

    https://github.com/apache/cordova-docs/pull/527#discussion_r54624737
  
    --- 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. 
    +- Moved Core Plugin docs, like [Cordova Plugin Camera](http://cordova.apache.org/docs/en/latest/cordova-plugin-camera/index.html),
from Github to be a part of the website so that they are now accessible from one place and
are easier to read.
    +- Fixed a number of Jira bugs related to documentation as a part of improving these articles.
    +
    +These all are reflected in the new Docs release and we would love to hear your feedback
so that we can continue to work on improving it.
    +
    +It's easy to provide feedback: 
    --- End diff --
    
    +1 PRs are welcome - using the edit button on the website.


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org


Mime
View raw message