Make example READMEs more consistent #10124

chibicode · 2020-01-16T09:47:11Z

This PR cleans up example README.md files so they follow a more consistent format.

Move "The idea behind the example" section to the top, as per discussion with @evilrabbit and @pacocoursey. By putting this at the top, you can quickly tell what the example is about. Unfortunately, I had to do this by hand because sometimes "The idea behind the next example" appeared on different locations (not necessary at the end)
Use npm init instead of npx create (to be consistent with zeit docs), and make installation instructions consistent. For this, I used the search & replace feature of VSCode.
Update contributing.md with the suggested example template

ijjk · 2020-01-16T09:53:28Z

Stats from current PR

Default Server Mode

General

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
buildDuration	12.6s	12.5s	-183ms
nodeModulesSize	48.9 MB	48.9 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
main-HASH.js gzip	5.1 kB	5.1 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..e54b.js gzip	13.7 kB	13.7 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	67.4 kB	67.4 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
main-HASH.module.js gzip	4.16 kB	4.16 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	12.5 kB	12.5 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	62.1 kB	62.1 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_app.js gzip	1.33 kB	1.33 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.9 kB	2.9 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.87 kB	9.87 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_app.module.js gzip	757 B	757 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.47 kB	2.47 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.41 kB	7.41 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Rendered Page Sizes

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
index.html gzip	1.02 kB	1.02 kB	✓
link.html gzip	1.03 kB	1.03 kB	✓
withRouter.html gzip	1.01 kB	1.01 kB	✓
Overall change	3.07 kB	3.07 kB	✓

Serverless Mode

General

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
buildDuration	12.8s	13.1s	⚠️ +297ms
nodeModulesSize	48.9 MB	48.9 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
main-HASH.js gzip	5.1 kB	5.1 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..e54b.js gzip	13.7 kB	13.7 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	67.4 kB	67.4 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
main-HASH.module.js gzip	4.16 kB	4.16 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	12.5 kB	12.5 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	62.1 kB	62.1 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_app.js gzip	1.33 kB	1.33 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.9 kB	2.9 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.87 kB	9.87 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_app.module.js gzip	757 B	757 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.47 kB	2.47 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.41 kB	7.41 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Serverless bundles

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_error.js gzip	77.8 kB	77.8 kB	✓
hooks.html gzip	1.05 kB	1.05 kB	✓
index.js gzip	78 kB	78 kB	✓
link.js gzip	80.4 kB	80.4 kB	✓
routerDirect.js gzip	78.1 kB	78.1 kB	✓
withRouter.js gzip	78.1 kB	78.1 kB	✓
Overall change	393 kB	393 kB	✓

Commit: 91180cb

lfades

LGTM

ijjk · 2020-01-16T21:47:48Z

Stats from current PR

Default Server Mode

General

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
buildDuration	10.8s	11s	⚠️ +216ms
nodeModulesSize	48.9 MB	48.9 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
main-HASH.js gzip	5.1 kB	5.1 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..e54b.js gzip	13.7 kB	13.7 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	67.4 kB	67.4 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
main-HASH.module.js gzip	4.16 kB	4.16 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	12.5 kB	12.5 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	62.1 kB	62.1 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_app.js gzip	1.33 kB	1.33 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.9 kB	2.9 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.87 kB	9.87 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_app.module.js gzip	757 B	757 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.47 kB	2.47 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.41 kB	7.41 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Rendered Page Sizes

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
index.html gzip	1.02 kB	1.02 kB	✓
link.html gzip	1.03 kB	1.03 kB	✓
withRouter.html gzip	1.01 kB	1.01 kB	✓
Overall change	3.07 kB	3.07 kB	✓

Serverless Mode

General

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
buildDuration	11.3s	11.2s	-71ms
nodeModulesSize	48.9 MB	48.9 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
main-HASH.js gzip	5.1 kB	5.1 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..e54b.js gzip	13.7 kB	13.7 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	67.4 kB	67.4 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
main-HASH.module.js gzip	4.16 kB	4.16 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	12.5 kB	12.5 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	62.1 kB	62.1 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_app.js gzip	1.33 kB	1.33 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.9 kB	2.9 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.87 kB	9.87 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_app.module.js gzip	757 B	757 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.47 kB	2.47 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.41 kB	7.41 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Serverless bundles

	zeit/next.js canary	chibicode/next.js update-example-docs	Change
_error.js gzip	77.8 kB	77.8 kB	✓
hooks.html gzip	1.05 kB	1.05 kB	✓
index.js gzip	78 kB	78 kB	✓
link.js gzip	80.4 kB	80.4 kB	✓
routerDirect.js gzip	78.1 kB	78.1 kB	✓
withRouter.js gzip	78.1 kB	78.1 kB	✓
Overall change	393 kB	393 kB	✓

Commit: 76f99e5

timneutkens · 2020-01-16T22:24:10Z

Merged as per Luis' approval.

chibicode added 12 commits January 15, 2020 17:18

npx create → npm init

4feab10

Fix inconsistent instructions

aefe977

Update amp-first

8756a46

Update with-graphql-react

1d2c1be

with-firebase-cloud-messaging

ed20173

Update with-higher-order-component

deb90c2

change create-next-app url

0606330

Update create-next-app instruction

17ead08

Update instructions to use npm instead of npx

f641910

Move "the idea behind the example" to top

8ac7667

Rename

364c9de

Rename

91180cb

chibicode requested review from lfades and Timer as code owners January 16, 2020 09:47

chibicode changed the title ~~Update example docs~~ Make example READMEs more consistent Jan 16, 2020

chibicode requested a review from timneutkens January 16, 2020 09:54

lfades approved these changes Jan 16, 2020

View reviewed changes

chibicode removed the request for review from timneutkens January 16, 2020 19:15

Update contributing.md with a README template

76f99e5

timneutkens merged commit 6804039 into vercel:canary Jan 16, 2020

Timer added the Documentation label Jan 16, 2020

This was referenced Feb 18, 2020

[Snyk] Upgrade next from 9.1.2 to 9.2.1 ndom91/newtelco-next-maintenance-mgmt#22

Closed

[Snyk] Upgrade next from 9.1.1 to 9.2.1 tinkerbox/mailyard-spa#10

Open

vercel locked as resolved and limited conversation to collaborators Jan 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make example READMEs more consistent #10124

Make example READMEs more consistent #10124

chibicode commented Jan 16, 2020 •

edited

ijjk commented Jan 16, 2020

lfades left a comment

ijjk commented Jan 16, 2020

timneutkens commented Jan 16, 2020

Make example READMEs more consistent #10124

Make example READMEs more consistent #10124

Conversation

chibicode commented Jan 16, 2020 • edited

ijjk commented Jan 16, 2020

Stats from current PR

lfades left a comment

Choose a reason for hiding this comment

ijjk commented Jan 16, 2020

Stats from current PR

timneutkens commented Jan 16, 2020

chibicode commented Jan 16, 2020 •

edited