-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Description
Describe the feature you'd like to request
I would like to have a beginners guide in the docs, this would include information that is essential to operating a turbo based monorepo. This would be good to add because many beginning users of turbo have never worked with a monorepo before.
Even adding a dependency to a package is a struggle, and the answer can often only be found by asking the community in Discord, or a GitHub issue.
Describe the solution you'd like
A page in the turborepo.com docs which has these things that are essential for the operating of a monorepo.
These aren't necessarily specific to turborepo in all cases. But are definitely applicable to any turborepo based monorepo.
Main things I would like to see in there are:
- Adding dependencies to a package
- Best practices
- Naming your workspaces/packages (Mainly don't name them after existing npm packages. Could also introduce the
@project/subproject
naming convention) - Keeping the same version of packages across the monorepo
- Naming your workspaces/packages (Mainly don't name them after existing npm packages. Could also introduce the
- Links to example projects such as the kitchen-sink example
Any other ideas for this list are appreciated
Describe alternatives you've considered
An alternative would be describing these things in the turborepo discord, Jared has already indicated that it is better to put it in the docs. Another alternative would be to add these parts to the FAQ of the docs, the reason I would rather have a beginners guide is because otherwise the FAQ may start becoming too large, and it could be a hassle to actually find your answer in there. This would allow a simple and collected space where beginners can get the most important information they need.