jquery / jquery/api.jquerymobile.com
All: Modules in potential need of documentation
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 55
- Forks
- 57
- PR merge metrics
- No merged PRs in 30d
Description
As I'm implementing the boilerplate for our library, I'm finding that I cannot produce a "docs" metadata field for some of our modules. Here are those we may (not) want to document/demo:
- zoom
- animationComplete
- navigation/base (do we even need it anymore? https://github.com/jquery/jquery-mobile/issues/7489)
- navigation/path (needs demos - maybe?)
- widgets/controlgroup.backcompat (needs
if ( $.mobileBackcompat )) - slider tooltip API (option popupEnabled and showValue)
- textarea autogrow has no demo
-
$.mobile.iosorientationfixEnabledneeds to be documented in global options (also, demo?) - accordion - docs and demos
- support - do we want docs/demos?
Can we use the "exclude" group to hide modules in the DB? I've encountered
//>>group: exclude
For example, our core, which is merely a bundling of other modules, is labelled thus.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the documentation boilerplate and the existing exclude group handling described in the issue, using the core module as the example. Clarify which listed modules need documentation or demos and which should be excluded. Done means the decisions are recorded and the affected modules produce the intended docs metadata or are consistently hidden.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jquery
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100