[
https://issues.apache.org/jira/browse/CB-10330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15111017#comment-15111017
]
ASF GitHub Bot commented on CB-10330:
-------------------------------------
Github user riknoll commented on the pull request:
https://github.com/apache/cordova-docs/pull/460#issuecomment-173656844
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: https://issues.apache.org/jira/browse/CB-10330
> 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
> CLI
> 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
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
