doc: Cordova JavaScript APIs (cordova.js)
- Dominant language
- JavaScript
- Stars
- 353
- Forks
- 565
- Avg merge
- 7h 15m
- Merged PRs (30d)
- 5
Description
**Issue Type**
[ ] Bug
[x] Feature Request
**Priority**
[ ] Minor
[x] Major
[ ] Critical
[ ] Blocker
**Environment**
* OS:
* Browser:
**Description**
It would be great if there was some text calling out that you need to include cordova.js and cordova-plugins.js in the main HTML file in order to get access to plugins and APIs, and that it makes the global cordova object available. The only indication that this needs to happen is that they're in the files produced by cordova create.
This caused some confusion for me, because I was integrating cordova into a web project, copied over my existing html file from the web side, and wasn't aware that those script tags needed to be in my file.
Contributor guide
Research direction
Start by locating the Cordova JavaScript API documentation and reviewing the cordova.js and cordova-plugins.js files mentioned in the issue. Add documentation explaining that both script tags are needed in the main HTML file for plugins and APIs, and that cordova.js exposes the global cordova object; done means this requirement is clear to someone integrating Cordova into an existing web project.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100