kriasoft / kriasoft/react-starter-kit
Getting started instructions no longer are accurate
- Dominant language
- TypeScript
- Stars
- 23.7k
- Forks
- 4.2k
- Avg merge
- 2h 6m
- Merged PRs (30d)
- 3
Description
It looks like you are in the middle of a slight rearchitecture and restructuring of the repository. As a result, the onboarding instructions in the readme file and the getting started file in the docs directly aren't in sync with each other, and following them doesn't get one up and running correctly. Could you please update one or both of those guides so that it is possible for someone to follow them from scratch and get the framework running successfully? It looks very interesting and I'd love to try it out for my project.
Contributor guide
Research direction
Compare the repository README with the getting started file in the docs, then follow each guide from a clean checkout to identify where their setup steps diverge. Update one or both guides so a new user can complete the instructions and successfully run the framework from scratch.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bun, react, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100