Add docs page for Create Next App #15454

MehediH · 2020-07-24T10:07:21Z

Following up from #14830, this PR adds a new page to the docs for Create Next App. The content is identical to the README created as part of #14830.

Also added a link on the main getting-started page to the new docs for Create Next App to help users find more info on Create Next App if needed.

I'm unsure as to whether the content for the documentation needs to be different from the one I wrote for the README. Please let me know if that's the case, and I will be happy to tweak the structure.

Updated to include more details about Next.js, link to the interactive tutorial, showcase, etc. Content mostly based on the official Next.js site.

An updated readme with more details on options, benefits, etc.

Co-authored-by: Luis Alvarez D. <[email protected]>

ijjk · 2020-07-24T10:15:43Z

Stats from current PR

Default Server Mode (Increase detected ⚠️)

General

	vercel/next.js canary	MehediH/next.js canary	Change
buildDuration	12.1s	12.2s	⚠️ +132ms
nodeModulesSize	66.4 MB	66.4 MB	✓

Page Load Tests Overall increase ✓

	vercel/next.js canary	MehediH/next.js canary	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.034	1.976	-0.06
/ avg req/sec	1229.35	1264.92	+35.57
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.209	1.196	-0.01
/error-in-render avg req/sec	2067.81	2090.05	+22.24

Client Bundles (main, webpack, commons)

	vercel/next.js canary	MehediH/next.js canary	Change
677f882d2ed8..d2f7.js gzip	10.1 kB	10.1 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
main-8da3811..3b61.js gzip	6.72 kB	6.72 kB	✓
polyfills-05..1236.js gzip	30.8 kB	30.8 kB	✓
webpack-488d..c0e7.js gzip	751 B	751 B	✓
Overall change	87.6 kB	87.6 kB	✓

Client Bundles (main, webpack, commons) Modern

	vercel/next.js canary	MehediH/next.js canary	Change
677f882d2ed8..dule.js gzip	6.1 kB	6.1 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
main-43a8e8b..dule.js gzip	5.79 kB	5.79 kB	✓
polyfills-05..dule.js gzip	30.8 kB	30.8 kB	✓
webpack-4f62..dule.js gzip	751 B	751 B	✓
Overall change	82.6 kB	82.6 kB	✓

Client Pages

	vercel/next.js canary	MehediH/next.js canary	Change
_app-8f5f611..1f7b.js gzip	1.28 kB	1.28 kB	✓
_error-8e69b..8695.js gzip	3.41 kB	3.41 kB	✓
hooks-f7f3d0..7465.js gzip	887 B	887 B	✓
index-08fb3f..c0e9.js gzip	227 B	227 B	✓
link-ddd176e..5566.js gzip	1.29 kB	1.29 kB	✓
routerDirect..8aa1.js gzip	284 B	284 B	✓
withRouter-f..e777.js gzip	284 B	284 B	✓
Overall change	7.66 kB	7.66 kB	✓

Client Pages Modern

	vercel/next.js canary	MehediH/next.js canary	Change
_app-669dbe5..dule.js gzip	626 B	626 B	✓
_error-663e6..dule.js gzip	2.24 kB	2.24 kB	✓
hooks-805c40..dule.js gzip	387 B	387 B	✓
index-6ba5a4..dule.js gzip	226 B	226 B	✓
link-69bc264..dule.js gzip	1.25 kB	1.25 kB	✓
routerDirect..dule.js gzip	284 B	284 B	✓
withRouter-d..dule.js gzip	282 B	282 B	✓
Overall change	5.29 kB	5.29 kB	✓

Client Build Manifests

	vercel/next.js canary	MehediH/next.js canary	Change
_buildManifest.js gzip	275 B	275 B	✓
_buildManife..dule.js gzip	281 B	281 B	✓
Overall change	556 B	556 B	✓

Rendered Page Sizes

	vercel/next.js canary	MehediH/next.js canary	Change
index.html gzip	946 B	946 B	✓
link.html gzip	952 B	952 B	✓
withRouter.html gzip	938 B	938 B	✓
Overall change	2.84 kB	2.84 kB	✓

Serverless Mode

General

	vercel/next.js canary	MehediH/next.js canary	Change
buildDuration	13.5s	13.2s	-255ms
nodeModulesSize	66.4 MB	66.4 MB	✓

Client Bundles (main, webpack, commons)

	vercel/next.js canary	MehediH/next.js canary	Change
677f882d2ed8..d2f7.js gzip	10.1 kB	10.1 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
main-8da3811..3b61.js gzip	6.72 kB	6.72 kB	✓
polyfills-05..1236.js gzip	30.8 kB	30.8 kB	✓
webpack-488d..c0e7.js gzip	751 B	751 B	✓
Overall change	87.6 kB	87.6 kB	✓

Client Bundles (main, webpack, commons) Modern

	vercel/next.js canary	MehediH/next.js canary	Change
677f882d2ed8..dule.js gzip	6.1 kB	6.1 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
main-43a8e8b..dule.js gzip	5.79 kB	5.79 kB	✓
polyfills-05..dule.js gzip	30.8 kB	30.8 kB	✓
webpack-4f62..dule.js gzip	751 B	751 B	✓
Overall change	82.6 kB	82.6 kB	✓

Client Pages

	vercel/next.js canary	MehediH/next.js canary	Change
_app-8f5f611..1f7b.js gzip	1.28 kB	1.28 kB	✓
_error-8e69b..8695.js gzip	3.41 kB	3.41 kB	✓
hooks-f7f3d0..7465.js gzip	887 B	887 B	✓
index-08fb3f..c0e9.js gzip	227 B	227 B	✓
link-ddd176e..5566.js gzip	1.29 kB	1.29 kB	✓
routerDirect..8aa1.js gzip	284 B	284 B	✓
withRouter-f..e777.js gzip	284 B	284 B	✓
Overall change	7.66 kB	7.66 kB	✓

Client Pages Modern

	vercel/next.js canary	MehediH/next.js canary	Change
_app-669dbe5..dule.js gzip	626 B	626 B	✓
_error-663e6..dule.js gzip	2.24 kB	2.24 kB	✓
hooks-805c40..dule.js gzip	387 B	387 B	✓
index-6ba5a4..dule.js gzip	226 B	226 B	✓
link-69bc264..dule.js gzip	1.25 kB	1.25 kB	✓
routerDirect..dule.js gzip	284 B	284 B	✓
withRouter-d..dule.js gzip	282 B	282 B	✓
Overall change	5.29 kB	5.29 kB	✓

Client Build Manifests

	vercel/next.js canary	MehediH/next.js canary	Change
_buildManifest.js gzip	275 B	275 B	✓
_buildManife..dule.js gzip	281 B	281 B	✓
Overall change	556 B	556 B	✓

Serverless bundles

	vercel/next.js canary	MehediH/next.js canary	Change
_error.js	881 kB	881 kB	✓
404.html	4.18 kB	4.18 kB	✓
hooks.html	3.82 kB	3.82 kB	✓
index.js	881 kB	881 kB	✓
link.js	922 kB	922 kB	✓
routerDirect.js	916 kB	916 kB	✓
withRouter.js	916 kB	916 kB	✓
Overall change	4.52 MB	4.52 MB	✓

Commit: 36808d3

docs/getting-started.md

docs/create-next-app.md

ijjk · 2020-08-03T13:15:38Z

Stats from current PR

Default Server Mode (Decrease detected ✓)

General

	vercel/next.js canary	MehediH/next.js canary	Change
buildDuration	12.4s	12.2s	-124ms
nodeModulesSize	65.5 MB	65.5 MB	✓

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	MehediH/next.js canary	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.195	2.221	⚠️ +0.03
/ avg req/sec	1138.8	1125.55	⚠️ -13.25
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.179	1.191	⚠️ +0.01
/error-in-render avg req/sec	2119.71	2098.35	⚠️ -21.36

Client Bundles (main, webpack, commons)

	vercel/next.js canary	MehediH/next.js canary	Change
677f882d2ed8..adde.js gzip	10.2 kB	10.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
main-5932771..4350.js gzip	6.73 kB	6.73 kB	✓
polyfills-4c..dbb6.js gzip	30.8 kB	30.8 kB	✓
webpack-ccf5..276a.js gzip	751 B	751 B	✓
Overall change	87.6 kB	87.6 kB	✓

Client Bundles (main, webpack, commons) Modern

	vercel/next.js canary	MehediH/next.js canary	Change
677f882d2ed8..dule.js gzip	6.13 kB	6.13 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
main-02cf3f6..dule.js gzip	5.81 kB	5.81 kB	✓
polyfills-4c..dule.js gzip	30.8 kB	30.8 kB	✓
webpack-10c7..dule.js gzip	751 B	751 B	✓
Overall change	82.7 kB	82.7 kB	✓

Client Pages

	vercel/next.js canary	MehediH/next.js canary	Change
_app-874bd8a..0103.js gzip	1.28 kB	1.28 kB	✓
_error-fa39c..ec40.js gzip	3.45 kB	3.45 kB	✓
hooks-585f07..95a3.js gzip	887 B	887 B	✓
index-c7b63f..fc02.js gzip	227 B	227 B	✓
link-ea5d131..c2be.js gzip	1.3 kB	1.3 kB	✓
routerDirect..ebc7.js gzip	284 B	284 B	✓
withRouter-2..db68.js gzip	284 B	284 B	✓
Overall change	7.72 kB	7.72 kB	✓

Client Pages Modern

	vercel/next.js canary	MehediH/next.js canary	Change
_app-97e743e..dule.js gzip	626 B	626 B	✓
_error-b4004..dule.js gzip	2.3 kB	2.3 kB	✓
hooks-696209..dule.js gzip	387 B	387 B	✓
index-a4dd74..dule.js gzip	226 B	226 B	✓
link-4448c30..dule.js gzip	1.25 kB	1.25 kB	✓
routerDirect..dule.js gzip	284 B	284 B	✓
withRouter-1..dule.js gzip	282 B	282 B	✓
Overall change	5.36 kB	5.36 kB	✓

Client Build Manifests

	vercel/next.js canary	MehediH/next.js canary	Change
_buildManifest.js gzip	273 B	273 B	✓
_buildManife..dule.js gzip	281 B	281 B	✓
Overall change	554 B	554 B	✓

Rendered Page Sizes

	vercel/next.js canary	MehediH/next.js canary	Change
index.html gzip	946 B	946 B	✓
link.html gzip	955 B	955 B	✓
withRouter.html gzip	940 B	940 B	✓
Overall change	2.84 kB	2.84 kB	✓

Serverless Mode

General

	vercel/next.js canary	MehediH/next.js canary	Change
buildDuration	13.6s	13.8s	⚠️ +178ms
nodeModulesSize	65.5 MB	65.5 MB	✓

Client Bundles (main, webpack, commons)

	vercel/next.js canary	MehediH/next.js canary	Change
677f882d2ed8..adde.js gzip	10.2 kB	10.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
main-5932771..4350.js gzip	6.73 kB	6.73 kB	✓
polyfills-4c..dbb6.js gzip	30.8 kB	30.8 kB	✓
webpack-ccf5..276a.js gzip	751 B	751 B	✓
Overall change	87.6 kB	87.6 kB	✓

Client Bundles (main, webpack, commons) Modern

	vercel/next.js canary	MehediH/next.js canary	Change
677f882d2ed8..dule.js gzip	6.13 kB	6.13 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
main-02cf3f6..dule.js gzip	5.81 kB	5.81 kB	✓
polyfills-4c..dule.js gzip	30.8 kB	30.8 kB	✓
webpack-10c7..dule.js gzip	751 B	751 B	✓
Overall change	82.7 kB	82.7 kB	✓

Client Pages

	vercel/next.js canary	MehediH/next.js canary	Change
_app-874bd8a..0103.js gzip	1.28 kB	1.28 kB	✓
_error-fa39c..ec40.js gzip	3.45 kB	3.45 kB	✓
hooks-585f07..95a3.js gzip	887 B	887 B	✓
index-c7b63f..fc02.js gzip	227 B	227 B	✓
link-ea5d131..c2be.js gzip	1.3 kB	1.3 kB	✓
routerDirect..ebc7.js gzip	284 B	284 B	✓
withRouter-2..db68.js gzip	284 B	284 B	✓
Overall change	7.72 kB	7.72 kB	✓

Client Pages Modern

	vercel/next.js canary	MehediH/next.js canary	Change
_app-97e743e..dule.js gzip	626 B	626 B	✓
_error-b4004..dule.js gzip	2.3 kB	2.3 kB	✓
hooks-696209..dule.js gzip	387 B	387 B	✓
index-a4dd74..dule.js gzip	226 B	226 B	✓
link-4448c30..dule.js gzip	1.25 kB	1.25 kB	✓
routerDirect..dule.js gzip	284 B	284 B	✓
withRouter-1..dule.js gzip	282 B	282 B	✓
Overall change	5.36 kB	5.36 kB	✓

Client Build Manifests

	vercel/next.js canary	MehediH/next.js canary	Change
_buildManifest.js gzip	273 B	273 B	✓
_buildManife..dule.js gzip	281 B	281 B	✓
Overall change	554 B	554 B	✓

Serverless bundles

	vercel/next.js canary	MehediH/next.js canary	Change
_error.js	1.02 MB	1.02 MB	✓
404.html	4.18 kB	4.18 kB	✓
hooks.html	3.82 kB	3.82 kB	✓
index.js	1.02 MB	1.02 MB	✓
link.js	1.06 MB	1.06 MB	✓
routerDirect.js	1.05 MB	1.05 MB	✓
withRouter.js	1.05 MB	1.05 MB	✓
Overall change	5.2 MB	5.2 MB	✓

Commit: 173e9a8

timneutkens

Didn't see @Timer's review

ijjk · 2020-08-03T13:36:18Z

Stats from current PR

Default Server Mode (Increase detected ⚠️)

General

	vercel/next.js canary	MehediH/next.js canary	Change
buildDuration	12.7s	12.6s	-138ms
nodeModulesSize	65.5 MB	65.5 MB	✓

Page Load Tests Overall increase ✓

	vercel/next.js canary	MehediH/next.js canary	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.272	2.255	-0.02
/ avg req/sec	1100.58	1108.75	+8.17
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.265	1.214	-0.05
/error-in-render avg req/sec	1976.79	2059.66	+82.87

Client Bundles (main, webpack, commons)

	vercel/next.js canary	MehediH/next.js canary	Change
677f882d2ed8..adde.js gzip	10.2 kB	10.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
main-5932771..4350.js gzip	6.73 kB	6.73 kB	✓
webpack-ccf5..276a.js gzip	751 B	751 B	✓
Overall change	56.8 kB	56.8 kB	✓

Client Bundles (main, webpack, commons) Modern

	vercel/next.js canary	MehediH/next.js canary	Change
677f882d2ed8..dule.js gzip	6.13 kB	6.13 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
main-02cf3f6..dule.js gzip	5.81 kB	5.81 kB	✓
webpack-10c7..dule.js gzip	751 B	751 B	✓
Overall change	51.8 kB	51.8 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	MehediH/next.js canary	Change
polyfills-4c..dbb6.js gzip	30.8 kB	30.8 kB	✓
Overall change	30.8 kB	30.8 kB	✓

Client Pages

	vercel/next.js canary	MehediH/next.js canary	Change
_app-874bd8a..0103.js gzip	1.28 kB	1.28 kB	✓
_error-fa39c..ec40.js gzip	3.45 kB	3.45 kB	✓
hooks-585f07..95a3.js gzip	887 B	887 B	✓
index-c7b63f..fc02.js gzip	227 B	227 B	✓
link-ea5d131..c2be.js gzip	1.3 kB	1.3 kB	✓
routerDirect..ebc7.js gzip	284 B	284 B	✓
withRouter-2..db68.js gzip	284 B	284 B	✓
Overall change	7.72 kB	7.72 kB	✓

Client Pages Modern

	vercel/next.js canary	MehediH/next.js canary	Change
_app-97e743e..dule.js gzip	626 B	626 B	✓
_error-b4004..dule.js gzip	2.3 kB	2.3 kB	✓
hooks-696209..dule.js gzip	387 B	387 B	✓
index-a4dd74..dule.js gzip	226 B	226 B	✓
link-4448c30..dule.js gzip	1.25 kB	1.25 kB	✓
routerDirect..dule.js gzip	284 B	284 B	✓
withRouter-1..dule.js gzip	282 B	282 B	✓
Overall change	5.36 kB	5.36 kB	✓

Client Build Manifests

	vercel/next.js canary	MehediH/next.js canary	Change
_buildManifest.js gzip	273 B	273 B	✓
_buildManife..dule.js gzip	281 B	281 B	✓
Overall change	554 B	554 B	✓

Rendered Page Sizes

	vercel/next.js canary	MehediH/next.js canary	Change
index.html gzip	946 B	946 B	✓
link.html gzip	955 B	955 B	✓
withRouter.html gzip	940 B	940 B	✓
Overall change	2.84 kB	2.84 kB	✓

Serverless Mode

General

	vercel/next.js canary	MehediH/next.js canary	Change
buildDuration	14s	14.2s	⚠️ +237ms
nodeModulesSize	65.5 MB	65.5 MB	✓

Client Bundles (main, webpack, commons)

	vercel/next.js canary	MehediH/next.js canary	Change
677f882d2ed8..adde.js gzip	10.2 kB	10.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
main-5932771..4350.js gzip	6.73 kB	6.73 kB	✓
webpack-ccf5..276a.js gzip	751 B	751 B	✓
Overall change	56.8 kB	56.8 kB	✓

Client Bundles (main, webpack, commons) Modern

	vercel/next.js canary	MehediH/next.js canary	Change
677f882d2ed8..dule.js gzip	6.13 kB	6.13 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
main-02cf3f6..dule.js gzip	5.81 kB	5.81 kB	✓
webpack-10c7..dule.js gzip	751 B	751 B	✓
Overall change	51.8 kB	51.8 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	MehediH/next.js canary	Change
polyfills-4c..dbb6.js gzip	30.8 kB	30.8 kB	✓
Overall change	30.8 kB	30.8 kB	✓

Client Pages

	vercel/next.js canary	MehediH/next.js canary	Change
_app-874bd8a..0103.js gzip	1.28 kB	1.28 kB	✓
_error-fa39c..ec40.js gzip	3.45 kB	3.45 kB	✓
hooks-585f07..95a3.js gzip	887 B	887 B	✓
index-c7b63f..fc02.js gzip	227 B	227 B	✓
link-ea5d131..c2be.js gzip	1.3 kB	1.3 kB	✓
routerDirect..ebc7.js gzip	284 B	284 B	✓
withRouter-2..db68.js gzip	284 B	284 B	✓
Overall change	7.72 kB	7.72 kB	✓

Client Pages Modern

	vercel/next.js canary	MehediH/next.js canary	Change
_app-97e743e..dule.js gzip	626 B	626 B	✓
_error-b4004..dule.js gzip	2.3 kB	2.3 kB	✓
hooks-696209..dule.js gzip	387 B	387 B	✓
index-a4dd74..dule.js gzip	226 B	226 B	✓
link-4448c30..dule.js gzip	1.25 kB	1.25 kB	✓
routerDirect..dule.js gzip	284 B	284 B	✓
withRouter-1..dule.js gzip	282 B	282 B	✓
Overall change	5.36 kB	5.36 kB	✓

Client Build Manifests

	vercel/next.js canary	MehediH/next.js canary	Change
_buildManifest.js gzip	273 B	273 B	✓
_buildManife..dule.js gzip	281 B	281 B	✓
Overall change	554 B	554 B	✓

Serverless bundles

	vercel/next.js canary	MehediH/next.js canary	Change
_error.js	1.02 MB	1.02 MB	✓
404.html	4.18 kB	4.18 kB	✓
hooks.html	3.82 kB	3.82 kB	✓
index.js	1.02 MB	1.02 MB	✓
link.js	1.06 MB	1.06 MB	✓
routerDirect.js	1.05 MB	1.05 MB	✓
withRouter.js	1.05 MB	1.05 MB	✓
Overall change	5.2 MB	5.2 MB	✓

Commit: 61ce326

timneutkens · 2020-08-04T07:53:59Z

Thanks @MehediH 💯

MehediH and others added 11 commits July 3, 2020 21:15

More helpful README

a784011

Updated to include more details about Next.js, link to the interactive tutorial, showcase, etc. Content mostly based on the official Next.js site.

create-next-app readme

f1b1b17

An updated readme with more details on options, benefits, etc.

Apply edits from code review

07a3add

Co-authored-by: Luis Alvarez D. <[email protected]>

Remove redundant intro

47e09f6

Update packages/create-next-app/README.md

8468e0f

Remove introduction and list in showcase

cd7d7b8

Apply suggestions from code review

af65835

Update packages/next/README.md

1ba35be

Merge branch 'canary' into canary

8b95780

Merge remote-tracking branch 'upstream/canary' into canary

37879ba

Add Create Next App documentation

36808d3

MehediH requested review from chibicode, ijjk, lfades, Timer and timneutkens as code owners July 24, 2020 10:07

ijjk added the type: documentation label Jul 24, 2020

timneutkens reviewed Aug 3, 2020

View reviewed changes

docs/getting-started.md Outdated Show resolved Hide resolved

Update docs/getting-started.md

173e9a8

Timer reviewed Aug 3, 2020

View reviewed changes

docs/create-next-app.md Outdated Show resolved Hide resolved

Timer reviewed Aug 3, 2020

View reviewed changes

docs/create-next-app.md Outdated Show resolved Hide resolved

timneutkens approved these changes Aug 3, 2020

View reviewed changes

timneutkens requested changes Aug 3, 2020

View reviewed changes

timneutkens added 2 commits August 3, 2020 15:18

Fix feedback from Joe

4077336

Fix style

5c095f4

timneutkens approved these changes Aug 3, 2020

View reviewed changes

Merge branch 'canary' into canary

61ce326

kodiakhq bot merged commit e89bcf7 into vercel:canary Aug 3, 2020

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docs page for Create Next App #15454

Add docs page for Create Next App #15454

MehediH commented Jul 24, 2020

ijjk commented Jul 24, 2020

ijjk commented Aug 3, 2020

timneutkens left a comment

ijjk commented Aug 3, 2020

timneutkens commented Aug 4, 2020

Add docs page for Create Next App #15454

Add docs page for Create Next App #15454

Conversation

MehediH commented Jul 24, 2020

ijjk commented Jul 24, 2020

Stats from current PR

ijjk commented Aug 3, 2020

Stats from current PR

timneutkens left a comment

Choose a reason for hiding this comment

ijjk commented Aug 3, 2020

Stats from current PR

timneutkens commented Aug 4, 2020