Documentation (docs.phonegap.com) Additions

3 views
Skip to first unread message

Joel Dare

unread,
Aug 25, 2010, 12:35:14 PM8/25/10
to phonegap
Someone should add some docs about the following notification
functions to the new docs.phonegaps.com documentation.

1. navigator.notification.loadingStart()
2. navigator.notification.loadingStop()
3. navigator.notification.activityStart()
4. navigator.notification.activityStop()

Are those docs a community project at all? I'd be happy to update if so...

Thanks,
Joel

Dave Johnson

unread,
Aug 25, 2010, 12:55:13 PM8/25/10
to Joel Dare, phonegap
The docs are forkable here: http://github.com/phonegap/phonegap-docs

The only thing to note about those methods is that they are only
supported on iPhone at the moment.

> --
> You received this message because you are subscribed to the Google
> Groups "phonegap" group.
> To post to this group, send email to phon...@googlegroups.com
> To unsubscribe from this group, send email to
> phonegap+u...@googlegroups.com
> For more options, visit this group at
> http://groups.google.com/group/phonegap?hl=en?hl=en
>
> For more info on PhoneGap or to download the code go to www.phonegap.com
>

Michael Brooks

unread,
Aug 26, 2010, 12:14:32 PM8/26/10
to phonegap
Hi Joel,

You're right, since these functions are bundled with PhoneGap, they
should be added to the documentation. Our initial push for
docs.phonegap.com was to document the PhoneGap core (functions that
are cross-platform *today*). There is still plenty to document.

I've created Lighthouse tickets for each of these functions:

Ticket #89: http://phonegap.lighthouseapp.com/projects/56308-documentation/tickets/89-add-ios-notificationloadingstart
Ticket #90: http://phonegap.lighthouseapp.com/projects/56308-documentation/tickets/90-add-ios-notificationloadingstop
Ticket #91: http://phonegap.lighthouseapp.com/projects/56308-documentation/tickets/91-add-ios-notificationactivitystart
Ticket #92: http://phonegap.lighthouseapp.com/projects/56308-documentation/tickets/92-add-ios-notificationactivitystop

I'm working on creating a contributor guide that explains how to
contribute back to the documentation. Until that is done, Dave is
right, the easiest way to get going is fork the docs and use an
existing function as a template for adding a new function.

I've also wrote a set of Git guides that relate to the documentation:

- Git Setup: http://wiki.phonegap.com/Git%3A-Setup
- Forking the PhoneGap Documentation:
http://wiki.phonegap.com/Git%3A-Forking-PhoneGap%C2%A0Documentation
- Contributor Workflow: http://wiki.phonegap.com/Git%3A-Contributor-Workflow
- Good Commit Message Format: http://wiki.phonegap.com/Git%3A-Commit-Message-Format
Reply all
Reply to author
Forward
0 new messages