node-graphql-server icon indicating copy to clipboard operation
node-graphql-server copied to clipboard

Rehaul READMEs and add top-level README

Open kbrandwijk opened this issue 7 years ago • 5 comments

The readme is included in the boilerplate, so it also ends up in the generated project, which doesn't make much sense.

kbrandwijk avatar Dec 16 '17 05:12 kbrandwijk

Why not? The different boilerplates are different enough, so that different README files are preferred.

marktani avatar Dec 16 '17 15:12 marktani

I think the idea is a shared README at the root and a slightly different README per boilerplate. At least that’s what J and I discussed yesterday afternoon.

On Dec 16, 2017, at 09:52, Nilan Marktanner [email protected] wrote:

Why not? The different boilerplates are different enough, so that different README files are preferred.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub, or mute the thread.

DevanB avatar Dec 16 '17 15:12 DevanB

Well, at the very least, they need to be completely overhauled.

  • It references a live demo
  • The node-basic once describe a project structure with index.ts, while it doesn't use typescript
  • The clone the repo steps are wrong
  • The getting started instructions is what you have already done to even get a local project with that readme
  • etc.

kbrandwijk avatar Dec 16 '17 15:12 kbrandwijk

We're tackling this right now, let's track the progress of the different repos and close it once all ore done:

nikolasburk avatar Dec 21 '17 14:12 nikolasburk

I remember @stubailo had a couple of thoughts on this. Would be great if we can get the ball rolling here ⚽️

schickling avatar Jan 01 '18 20:01 schickling