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

[v2] default starter: update README #6940

Closed
shannonbux opened this issue Aug 1, 2018 · 0 comments
Closed

[v2] default starter: update README #6940

shannonbux opened this issue Aug 1, 2018 · 0 comments
Assignees
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@shannonbux
Copy link
Contributor

shannonbux commented Aug 1, 2018

Summary

Lots of people read the default starter READme (it's one of the most used starters with Gatsby and has more stars than most other starters) and currently it only has installation instructions.

It'd be great to give people a "tour" of the starter structure and explain what each directory is for (directories that are unique to Gatsby).

Link to default starter source code: https://github.com/gatsbyjs/gatsby-starter-default

Motivation

People often ask about how Gatsby works so that they can have flexible knowledge to apply to new use cases and resolve bugs, and the default starter READme would be a great way to learn about how a Gatsby site works.

@shannonbux shannonbux added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Aug 1, 2018
pragmaticpat pushed a commit to pragmaticpat/gatsby that referenced this issue Apr 28, 2022
pragmaticpat pushed a commit to pragmaticpat/gatsby that referenced this issue Apr 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

3 participants