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.

Sign up for GitHub

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

Jump to bottom

Update boilerplate/README.md #2653

Open
frankcalise opened this issue Mar 15, 2024 · 1 comment
Open

Update boilerplate/README.md #2653

frankcalise opened this issue Mar 15, 2024 · 1 comment
Assignees
@flexbox
Labels
docs enhancement good first issue A fairly straightforward change if you're looking to contribute for the first time help wanted

Comments

@frankcalise
Copy link
Contributor

Description

After you Ignite a new app, there is a generated README.md - it's a bit outdated in terms of directory structure, what next steps are, etc. We should update this to be more helpful
@frankcalise frankcalise added help wanted docs enhancement good first issue A fairly straightforward change if you're looking to contribute for the first time labels Mar 15, 2024
@turquoisemelon
Copy link

Hello 👋🏻
I would like to help, if this issue is still relevant! On an initial look, I see Boilerplate.md file under docs folder seeming to have similar but more up-to-date content to generated README.md (Boilerplate.md updated a month ago). Would it make sense to port that over to generated README.md?

@flexbox flexbox self-assigned this Oct 16, 2024
flexbox added a commit that referenced this issue Oct 18, 2024
@flexbox
docs: revamp boilerplate README for v10 closes #2653
ff5ef31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@flexbox flexbox

Labels
docs enhancement good first issue A fairly straightforward change if you're looking to contribute for the first time help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@flexbox @frankcalise @turquoisemelon