[docs] suggestion: clarify what starters are #5866
Labels
help wanted
Issue with a clear description that the community can help with.
stale?
Issue that may be closed soon due to the original author not responding any more.
type: documentation
An issue or pull request for improving or updating Gatsby's documentation
problem statement
Currently our docs say:
The Gatsby CLI tool lets you install “starters”. These are partially built sites preconfigured to help you get moving faster on creating a certain type of site.
i think this might send the wrong message that "starters" are a special concept that needs several requirements, in the way that
create-react-app
has special requirements if you want to do customreact-scripts
. this was my initial assumption when learning gatsby and it was wrong. it's also a barrier to creating more starters.it should be more obvious that
gatsby new
is no more thangit clone && rm -rf .git/ && yarn
(ornpm i
)suggested solution
Change the wording in the docs:
The Gatsby CLI tool lets you install “starters”. These are boilerplate Gatsby sites maintained by the community. `gatsby new` helps you start your project by cloning the boilerplate, installing dependencies, and clearing git history. If you are familiar with `git` this is the same as `git clone && rm -rf .git/ && yarn` (or `npm i`).
future ideas
enhance the CLI to offer official and recently used starters
or at least directly launch to the starter showcase. (#5334)
The text was updated successfully, but these errors were encountered: