Skip to content
This repository has been archived by the owner on May 26, 2022. It is now read-only.

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

Open
ed42311 opened this issue Aug 15, 2020 · 3 comments
Open

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

ed42311 opened this issue Aug 15, 2020 · 3 comments
Labels
good first issue help wanted react-ts Issues dealing with the react typescript template

Comments

@ed42311
Copy link
Contributor

ed42311 commented Aug 15, 2020

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

@ed42311 ed42311 added help wanted good first issue react-ts Issues dealing with the react typescript template labels Aug 15, 2020
@ed42311 ed42311 changed the title Update Docs in web-react-ts from CRA TS to project specific. Update Docs in web-react-ts from CRA TS to be project specific Aug 15, 2020
@KazChe
Copy link

KazChe commented Nov 14, 2020

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
Copy link
Contributor Author

ed42311 commented Nov 18, 2020

@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
Copy link
Contributor Author

ed42311 commented Nov 18, 2020

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue help wanted react-ts Issues dealing with the react typescript template
Projects
None yet
Development

No branches or pull requests

2 participants