docs(examples): refresh cms-prismic example
#40121
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
angeloashmore
requested review from
timneutkens,
ijjk,
shuding,
styfle,
leerob,
steven-tey and
balazsorban44
as code owners
balazsorban44
requested changes
Sep 13, 2022
There was a problem hiding this comment.
Nice work! Could we turn this example into TypeScript? This is preferred as pointed out in our contributing document: https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples
|
@balazsorban44 Certainly! Out of curiosity, do you have any insight on how non-TypeScript developers use these examples projects? Does using TypeScript in examples pose a challenge to these developers? |
|
@angeloashmore we believe that everyone should start off with TypeScript. Not only it gives a better developer experience but will catch many bugs before going to production. Types can be stripped away, and it would still be valid TypeScript, as it is just a superset of JavaScript, so developers who do not want TypeScript can just do so after cloning the example. |
balazsorban44
approved these changes
Sep 29, 2022
BowlingX
pushed a commit
to BowlingX/next.js
that referenced
this pull request
Oct 5, 2022
## Documentation / Examples - [ ] Make sure the linting passes by running `pnpm lint` - [x] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples) **Note**: `pnpm lint` fails on code unrelated to the changes in this PR. This PR updates the [Prismic](https://prismic.io/) CMS example (`examples/cms-prismic`) to use the latest Prismic libraries, tools, and conventions. - Uses `npx @slicemachine/init` to bootstrap new Prismic accounts and content repositories. - Uses [Slice Machine](https://prismic.io/docs/technologies/slice-machine) to model content. - Uses [Slices](https://prismic.io/docs/technologies/slice) to write post content. - Uses the latest versions of the following packages: - `@prismicio/client` - `@prismicio/helpers` - `@prismicio/react` - `@prismicio/next` - Adds generated TypeScript types for Prismic content. The example remains as a JavaScript codebase (i.e. not TypeScript), but makes use of the types via JSDoc. Co-authored-by: Balázs Orbán <info@balazsorban.com>
Kikobeats
pushed a commit
to Kikobeats/next.js
that referenced
this pull request
Oct 24, 2022
## Documentation / Examples - [ ] Make sure the linting passes by running `pnpm lint` - [x] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples) **Note**: `pnpm lint` fails on code unrelated to the changes in this PR. This PR updates the [Prismic](https://prismic.io/) CMS example (`examples/cms-prismic`) to use the latest Prismic libraries, tools, and conventions. - Uses `npx @slicemachine/init` to bootstrap new Prismic accounts and content repositories. - Uses [Slice Machine](https://prismic.io/docs/technologies/slice-machine) to model content. - Uses [Slices](https://prismic.io/docs/technologies/slice) to write post content. - Uses the latest versions of the following packages: - `@prismicio/client` - `@prismicio/helpers` - `@prismicio/react` - `@prismicio/next` - Adds generated TypeScript types for Prismic content. The example remains as a JavaScript codebase (i.e. not TypeScript), but makes use of the types via JSDoc. Co-authored-by: Balázs Orbán <info@balazsorban.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation / Examples
pnpm lintNote:
pnpm lintfails on code unrelated to the changes in this PR.This PR updates the Prismic CMS example (
examples/cms-prismic) to use the latest Prismic libraries, tools, and conventions.Uses
npx @slicemachine/initto bootstrap new Prismic accounts and content repositories.Uses Slice Machine to model content.
Uses Slices to write post content.
Uses the latest versions of the following packages:
@prismicio/client@prismicio/helpers@prismicio/react@prismicio/nextAdds generated TypeScript types for Prismic content. The example remains as a JavaScript codebase (i.e. not TypeScript), but makes use of the types via JSDoc.