cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Lisa Seacat DeLuca <ldel...@us.ibm.com>
Subject Re: [Input request] Rethinking Plugin docs
Date Mon, 24 Feb 2014 19:21:25 GMT
If README.md is the standard why not just call all of them README and not 
have an index.md file at all for the plugins.  What is the advantage of 
having both?  Seems more confusing than anything.

Lisa Seacat DeLuca
Mobile Engineer | t: +415.787.4589 | ldeluca@apache.org | | 
ldeluca@us.ibm.com | lisaseacat.com | | 





From:   Andrew Grieve <agrieve@chromium.org>
To:     dev <dev@cordova.apache.org>
Date:   02/24/2014 01:41 PM
Subject:        Re: [Input request] Rethinking Plugin docs
Sent by:        agrieve@google.com



On Mon, Feb 24, 2014 at 12:51 PM, Marcel Kinard <cmarcelk@gmail.com> 
wrote:

>
> On Feb 24, 2014, at 12:32 PM, Andrew Grieve <agrieve@chromium.org> 
wrote:
>
> > - We may also want to include README.md files in the translations.
> > doc/fr/index.md
> > doc/fr/README.md
>
> What content do you forsee being in README.md other than a
> table-of-contents to the languages? Or in other words, would it be
> public-facing content that could be collapsed in to the rest of the 
plugin
> docs?
>

On npmjs.org and on github, README.md's are the files that are shown most
prominently. So, I speculate that many plugins will not provide a doc/
index.md, and instead provide only a README.md.


>
> > - We don't need the version in the directory since we can use git tags 
to
> > find old versions
>
> That makes sense.
>
>


Mime
  • Unnamed multipart/related (inline, None, 0 bytes)
View raw message