[
https://issues.apache.org/jira/browse/CB-13277?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16166193#comment-16166193
]
ASF GitHub Bot commented on CB-13277:
-------------------------------------
GitHub user janpio opened a pull request:
https://github.com/apache/cordova-docs/pull/730
CB-13277: (docs) Improve README
https://issues.apache.org/jira/browse/CB-13277
### Platforms affected
none
### What does this PR do?
Improves the README of cordova-docs.
See commit messages (and of course diff) for exact changes.
### What testing has been done on this change?
looked at the rendered readme in my fork on Github
### Checklist
- [x] [Reported an issue](http://cordova.apache.org/contribute/issues.html)
in the JIRA database
- [x] Commit message follows the format: "CB-3232: (android) Fix bug with
resolving file paths", where CB-xxxx is the JIRA ID & "android" is the platform
affected.
- [x] Added automated test coverage as appropriate for this change.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/janpio/cordova-docs improve-readme
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/cordova-docs/pull/730.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #730
----
commit ff306f60d4a9b197e636dcd5cf47d0e1bef33af9
Author: Jan Piotrowski <piotrowski+git...@gmail.com>
Date: 2017-09-14T11:25:01Z
improve Introduction
rephrase
add links to actual pages, not just redirects
commit 3fdb9332100a221b7f34f9377d7767e310c990b9
Author: Jan Piotrowski <piotrowski+git...@gmail.com>
Date: 2017-09-14T11:31:22Z
improve Installing
reword a bit
add some structure (Verify headline)
commit e7a4f964e9ced0b2bdf9919ca3af151f73620554
Author: Jan Piotrowski <piotrowski+git...@gmail.com>
Date: 2017-09-14T11:43:05Z
rework headlines
add h1 with repo name
change indentation
change some bold used to structure content to headlines
commit 8bec7671d90ce30a516b00667f31603b9e2ee03a
Author: Jan Piotrowski <piotrowski+git...@gmail.com>
Date: 2017-09-14T11:47:43Z
add Table of Contents
generated with https://ecotrust-canada.github.io/markdown-toc/
polished manually
----
> Improve README
> --------------
>
> Key: CB-13277
> URL: https://issues.apache.org/jira/browse/CB-13277
> Project: Apache Cordova
> Issue Type: Sub-task
> Components: cordova-docs
> Reporter: Jan Piotrowski (Sujan)
> Assignee: Jan Piotrowski (Sujan)
>
> README could use some improvement in struture and content
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
