Commit graph

6 commits

Author SHA1 Message Date
Anthony Shew
f60bf3c339
docs: enhance examples tables (#10173)
### Description

Updating the examples table in docs.

- Uses the `examples/` directory as the source of truth rather than a
JSON hardcode
- Adds validation to examples data (One could argue that this is done in
the wrong part of the repository, but we'll call that a problem for
another day.)
- Updates data in `examples/*/meta.json`

### Testing Instructions

Take a look!:
https://turbo-site-git-shew-5798f.vercel.sh/repo/docs/getting-started/examples#core-maintained-examples

---------

Co-authored-by: Chris Olszewski <chris.olszewski@vercel.com>
2025-03-17 12:39:17 -06:00
Anthony Shew
cbdeecdc88
chore(examples): mark core supported examples (#9707)
### Description

The community has been contributing more and more examples as Turborepo
usage has grown. This is _so exciting_ for those of us on the core team,
but we've had a hard time maintaining so many examples. It's a lot of
work to keep up with the breadth of tools that work great with
Turborepo, and the JavaScript ecosystem moves fast.

Because of this, we've come up with a strategy so that we can set
expectations correctly with the community. We're picking out ~5 examples
that we're committing to maintaining as shining representatives of
JavaScript monorepo greatness, leaving the rest to be maintained by the
community.

We will communicate this directly in `create-turbo` invocations, leaving
a note for users when they pick out a community-supported example.
 
### Testing Instructions
Should not show a `Note` log: `devcreateturbo --example
https://github.com/vercel/turborepo/tree/shew-0f97e/examples/basic`
Should show a `Note` log: `devcreateturbo --example
https://github.com/vercel/turborepo/tree/shew-0f97e/examples/with-docker`
2025-01-17 13:06:59 -05:00
Anthony Shew
b00eea2867
chore: update basic example to ESLint v9 and Flat Configurations. (#9501)
### Description

This PR converts our `basic` example to ESLint v9 with Flat
Configurations.

I may have a few gray hairs now, but I'm very excited for the community
to have this.

### Testing Instructions

Use `npx create-turbo@canary -e
https://github.com/vercel/turborepo/tree/shew-409f3/examples/basic
basic-eslint-9` to try it out.

- Pull it down, make sure you see diagnostics where you'd expect in your
editor. Including for `eslint-config-turbo`, most importantly!
- I know the diff is big, but there may be vestigials from my
experimenting lying around. Please use a finely toothed comb! (I've
looked myself but the more eyes, the better.)

---------

Co-authored-by: vincenthsh <111712068+vincenthsh@users.noreply.github.com>
2024-11-25 09:30:14 -07:00
Thomas Knickman
6670a2f8fc
feat(examples): update basic name on docs (#5224) 2023-06-09 19:15:16 +00:00
Thomas Knickman
b2f733748b
feat(docs): sort examples (#5123) 2023-05-30 16:00:15 -04:00
Thomas Knickman
4ed0472a83
feat(docs): use ssg for examples (#4014)
Add examples to docs via SSG and add new page in getting started to
improve discoverability.

@anthonyshew feel free to workshop these titles.

---------

Co-authored-by: Anthony Shew <anthony.shew@vercel.com>
2023-02-28 16:48:15 -05:00