-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOCUMENTATION] New user guide #39
Comments
What is the current README missing that you would suggest we add to this "new user guide?" |
I put this as a placeholder thought, but may or may not necessary depending on how the README evolves. The main idea I want to document here (once the ideas are established concretely) is where all external services are located and how to access them (e.g., Vercel, [TBD backend system], Chromatic, etc.), which might overclutter the README at some point and warrant its own separate thing. Time will tell! |
This could tie in with the artefacts produced from #40 Something else we could adopt to improve the new user experience is the normalised script pattern. It's essentially a set of bash scripts that bundle up the commands you normally see in a README into consistently named files. The .devcontainer fast path we have might alleviate the need for this, but it's nice to have non-Dockerised scripts that people can run if they want to. It'll also be useful if/when we have more repos. |
This issue is stale because it has been open for 60 days with no activity. |
Add a markdown file describing the general overview of the app & architecture, how to run locally, etc. May involve pulling some information out of / trimming down the general README
The text was updated successfully, but these errors were encountered: