cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <>
Subject [jira] [Commented] (CB-10330) Define a standard way to document references in the new IA
Date Thu, 21 Jan 2016 18:05:39 GMT


ASF GitHub Bot commented on CB-10330:

Github user riknoll commented on the pull request:
    The content looks good to me, but I had difficulty reading the document. It wasn't clear
to me which parts of it are examples and which are the guidelines. The examples are all inline
and they include headers, which makes everything a bit confusing because the example appears
bigger than the guideline it corresponds to. It would be nice if they could be differentiated
in some way (maybe the examples could be put in a "well" like a code block is).

> Define a standard way to document references in the new IA
> ----------------------------------------------------------
>                 Key: CB-10330
>                 URL:
>             Project: Apache Cordova
>          Issue Type: Task
>          Components: Docs
>            Reporter: Raghav
>            Assignee: Raghav
>              Labels: Docs-6.x
> We have a new section for references in the new IA which will have the following articles:
> Config.xml
> Events
> Plugin APIs
> Hooks
> Plugin.xml
> We need to define a uniform standard for these to follow. Some of these are API references,
some XML. 

This message was sent by Atlassian JIRA

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message