That was basically the question in my head as I was typing... I'd be happy with having just a README.md, and allowing it to link to relative .md paths if it wanted to.
On Mon, Feb 24, 2014 at 2:21 PM, Lisa Seacat DeLuca <[email protected]>wrote: > 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 | > *[email protected]*<[email protected]>| | > *[email protected]* <[email protected]> | > *lisaseacat.com*<http://www.lisaseacat.com/>| [image: > follow @LisaSeacat on twitter] <http://www.twitter.com/LisaSeacat>| [image: > follow Lisa Seacat DeLuca on linkedin]<http://www.linkedin.com/in/lisaseacat> > > > > > > From: Andrew Grieve <[email protected]> > To: dev <[email protected]> > Date: 02/24/2014 01:41 PM > Subject: Re: [Input request] Rethinking Plugin docs > Sent by: [email protected] > ------------------------------ > > > > On Mon, Feb 24, 2014 at 12:51 PM, Marcel Kinard <[email protected]> > wrote: > > > > > On Feb 24, 2014, at 12:32 PM, Andrew Grieve <[email protected]> > 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. > > > > > >
