erisu commented on code in PR #568:
URL: https://github.com/apache/cordova/pull/568#discussion_r2465326018


##########
README.md:
##########
@@ -1,3 +1,6 @@
+# Introduction
+This repository is a landing page for Cordova specific repositories, some 
documentations and home for discussions. It does not reflect the npm package 
`cordova` which  is the Cordova command line interface. That repository can be 
found under [apache/cordova-cli](https://github.com/apache/cordova-cli).

Review Comment:
   ```suggestion
   ## About this Repository
   
   This repository is a landing page for Cordova specific repositories, some 
documentations and home for discussions. It does not reflect the npm package 
`cordova` which  is the Cordova command line interface. That repository can be 
found under [apache/cordova-cli](https://github.com/apache/cordova-cli).
   ```
   
   This is more of an opinion, but:
   
   - This section should be below the `# Apache Cordova` section and above `## 
Filing a Bug` section.
   - This section should also be a sub section. Usually I try to follow the 
markdown-lint rules. I think it complains by default with the following: [MD025 
- Multiple top level headers in the same 
document](https://github.com/updownpress/markdown-lint/blob/master/rules/025-single-h1.md)
 .
   - I also added a new line between header and content: [MD022 - Headers 
should be surrounded by blank 
lines](https://github.com/updownpress/markdown-lint/blob/master/rules/025-single-h1.md)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to