Skip to content
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

Open
awpala opened this issue May 11, 2022 · 4 comments
Open

[DOCUMENTATION] New user guide #39

awpala opened this issue May 11, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request no-issue-activity

Comments

@awpala
Copy link
Contributor

awpala commented May 11, 2022

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

@awpala awpala added the documentation Improvements or additions to documentation label May 11, 2022
@awpala awpala added this to the 1.0 - MVP milestone May 11, 2022
@knakamura13
Copy link
Contributor

What is the current README missing that you would suggest we add to this "new user guide?"
For example, it already has instructions for how to run locally and it's fairly trimmed down at the moment.

@driscoll42 driscoll42 moved this to Staging in OMSHub Project Tasks May 13, 2022
@awpala
Copy link
Contributor Author

awpala commented May 13, 2022

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!

@disposedtrolley
Copy link
Contributor

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

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.

@awpala awpala removed the status in OMSHub Project Tasks Aug 7, 2022
@awpala awpala modified the milestones: 1.0 - MVP, 2.0 - Refinement Aug 8, 2022
@awpala awpala moved this to Icebox in OMSHub Project Tasks Aug 13, 2022
@awpala awpala added the enhancement New feature or request label Aug 13, 2022
@omshub omshub deleted a comment from github-actions bot Aug 27, 2024
Copy link

This issue is stale because it has been open for 60 days with no activity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request no-issue-activity
Projects
Status: Icebox
Development

No branches or pull requests

3 participants