search

grand-stack / grand-stack-starter

Simple starter project for GRANDstack full stack apps
https://grandstack.io/docs/getting-started-grand-stack-starter.html
Apache License 2.0
506 stars 161 forks source link

Update Docs in `web-react-ts` from CRA TS to be project specific #116

Open ed42311 opened 4 years ago

ed42311 commented 4 years ago

We have a great template starter for Typescript in react created by @ltwlf

The readme probably needs a bit of an update to document project specifics: https://github.com/grand-stack/grand-stack-starter/blob/master/web-react-ts/README.md

Maybe something more along these lines: https://github.com/grand-stack/grand-stack-starter/blob/master/web-react/README.md

KazChe commented 3 years ago

hey @ed42311 would it make sense to change the typescript README to point to the other README? Unless there are typescript specific steps that need to be taken that I might be missing?

ed42311 commented 3 years ago

@KazChe There are going to be a few differences for sure the readme doc has some real depth. What stands out to me at a quick glance is the linter: https://github.com/grand-stack/grand-stack-starter/blob/master/web-react/README.md#formatting-code-automatically

I also see 3/4 more areas that would need updating.

These are minor changes in some ways, i.e. you need ts in the search pattern, but it's going to be real frustrating for someone building if they don't have deep understanding of TS yet...

idk might be worth doing more modularized docs or a wiki type setup. if you want to take a run at it, go for it, if not I'll look at the organization next time I'm in this neck of the woods.

ed42311 commented 3 years ago

A starter step might be to link into the doc with things are the same and expound on the readme were they are different.