Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve formatting in examples #17571

Merged
merged 1 commit into from
Oct 2, 2020
Merged

Improve formatting in examples #17571

merged 1 commit into from
Oct 2, 2020

Conversation

rdimaio
Copy link
Contributor

@rdimaio rdimaio commented Oct 2, 2020

No description provided.

@ijjk ijjk added the examples Issue/PR related to examples label Oct 2, 2020
@ijjk
Copy link
Member

ijjk commented Oct 2, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General
vercel/next.js canary rdimaio/next.js canary Change
buildDuration 13.9s 13.7s -205ms
nodeModulesSize 63.1 MB 63.1 MB
Page Load Tests Overall increase ✓
vercel/next.js canary rdimaio/next.js canary Change
/ failed reqs 0 0
/ total time (seconds) 2.715 2.68 -0.03
/ avg req/sec 920.69 932.79 +12.1
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.572 1.538 -0.03
/error-in-render avg req/sec 1590.19 1625.04 +34.85
Client Bundles (main, webpack, commons)
vercel/next.js canary rdimaio/next.js canary Change
677f882d2ed8..9339.js gzip 10.9 kB 10.9 kB
framework.HASH.js gzip 39 kB 39 kB
main-d493e7d..42f5.js gzip 7.17 kB 7.17 kB
webpack-e067..f178.js gzip 751 B 751 B
Overall change 57.8 kB 57.8 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary rdimaio/next.js canary Change
677f882d2ed8..dule.js gzip 6.77 kB 6.77 kB
framework.HA..dule.js gzip 39 kB 39 kB
main-f8905d4..dule.js gzip 6.24 kB 6.24 kB
webpack-07c5..dule.js gzip 751 B 751 B
Overall change 52.7 kB 52.7 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary rdimaio/next.js canary Change
polyfills-4b..e242.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary rdimaio/next.js canary Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB
_error-ed1b0..8fbd.js gzip 3.44 kB 3.44 kB
hooks-89731c..c609.js gzip 887 B 887 B
index-17468f..5d83.js gzip 227 B 227 B
link-d2344ce..8b36.js gzip 1.3 kB 1.3 kB
routerDirect..924c.js gzip 284 B 284 B
withRouter-7..c13d.js gzip 284 B 284 B
Overall change 7.71 kB 7.71 kB
Client Pages Modern
vercel/next.js canary rdimaio/next.js canary Change
_app-75d3a82..dule.js gzip 625 B 625 B
_error-4469a..dule.js gzip 2.29 kB 2.29 kB
hooks-cbf13f..dule.js gzip 387 B 387 B
index-b9a643..dule.js gzip 226 B 226 B
link-f8c0daf..dule.js gzip 1.26 kB 1.26 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-f..dule.js gzip 282 B 282 B
Overall change 5.36 kB 5.36 kB
Client Build Manifests
vercel/next.js canary rdimaio/next.js canary Change
_buildManifest.js gzip 322 B 322 B
_buildManife..dule.js gzip 329 B 329 B
Overall change 651 B 651 B
Rendered Page Sizes
vercel/next.js canary rdimaio/next.js canary Change
index.html gzip 1 kB 1 kB
link.html gzip 1.01 kB 1.01 kB
withRouter.html gzip 996 B 996 B
Overall change 3.01 kB 3.01 kB

Serverless Mode
General
vercel/next.js canary rdimaio/next.js canary Change
buildDuration 15.6s 15.6s ⚠️ +31ms
nodeModulesSize 63.1 MB 63.1 MB
Client Bundles (main, webpack, commons)
vercel/next.js canary rdimaio/next.js canary Change
677f882d2ed8..9339.js gzip 10.9 kB 10.9 kB
framework.HASH.js gzip 39 kB 39 kB
main-d493e7d..42f5.js gzip 7.17 kB 7.17 kB
webpack-e067..f178.js gzip 751 B 751 B
Overall change 57.8 kB 57.8 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary rdimaio/next.js canary Change
677f882d2ed8..dule.js gzip 6.77 kB 6.77 kB
framework.HA..dule.js gzip 39 kB 39 kB
main-f8905d4..dule.js gzip 6.24 kB 6.24 kB
webpack-07c5..dule.js gzip 751 B 751 B
Overall change 52.7 kB 52.7 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary rdimaio/next.js canary Change
polyfills-4b..e242.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary rdimaio/next.js canary Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB
_error-ed1b0..8fbd.js gzip 3.44 kB 3.44 kB
hooks-89731c..c609.js gzip 887 B 887 B
index-17468f..5d83.js gzip 227 B 227 B
link-d2344ce..8b36.js gzip 1.3 kB 1.3 kB
routerDirect..924c.js gzip 284 B 284 B
withRouter-7..c13d.js gzip 284 B 284 B
Overall change 7.71 kB 7.71 kB
Client Pages Modern
vercel/next.js canary rdimaio/next.js canary Change
_app-75d3a82..dule.js gzip 625 B 625 B
_error-4469a..dule.js gzip 2.29 kB 2.29 kB
hooks-cbf13f..dule.js gzip 387 B 387 B
index-b9a643..dule.js gzip 226 B 226 B
link-f8c0daf..dule.js gzip 1.26 kB 1.26 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-f..dule.js gzip 282 B 282 B
Overall change 5.36 kB 5.36 kB
Client Build Manifests
vercel/next.js canary rdimaio/next.js canary Change
_buildManifest.js gzip 322 B 322 B
_buildManife..dule.js gzip 329 B 329 B
Overall change 651 B 651 B
Serverless bundles
vercel/next.js canary rdimaio/next.js canary Change
_error.js 1.05 MB 1.05 MB
404.html 4.34 kB 4.34 kB
hooks.html 3.92 kB 3.92 kB
index.js 1.05 MB 1.05 MB
link.js 1.1 MB 1.1 MB
routerDirect.js 1.09 MB 1.09 MB
withRouter.js 1.09 MB 1.09 MB
Overall change 5.4 MB 5.4 MB
Commit: 2829ff9

@lfades lfades added the spam label Oct 2, 2020
@lfades
Copy link
Member

lfades commented Oct 2, 2020

These changes are not valid and looks like spam, please open an issue before creating a PR.

@lfades lfades closed this Oct 2, 2020
@rdimaio
Copy link
Contributor Author

rdimaio commented Oct 2, 2020

These changes are not valid and looks like spam, please open an issue before creating a PR.

Not sure why they wouldn't be valid?

  • in examples/api-routes-rest/README.md: the README first uses "API", then "api". It does not look consistent to write it in lowercase after you just wrote it in uppercase, especially considering API is an acronym.

  • Conventionally, the first letter of Markdown is capitalized, considering it's the name of a language (GitHub also capitalizes it: https://guides.github.com/features/mastering-markdown/). If you think it's fine to leave it as "markdown", would you also then be fine with the docs having the words "next.js", "wordpress", "typescript" not properly capitalized?

And I'm not trying to be confrontational here, I just want to improve the consistency of these docs.

@timneutkens timneutkens reopened this Oct 2, 2020
@timneutkens timneutkens removed the spam label Oct 2, 2020
@kodiakhq kodiakhq bot merged commit 10f7b8f into vercel:canary Oct 2, 2020
@timneutkens
Copy link
Member

Hey @rdimaio we're battling spam from hacktoberfest and these generally manifest with users that create empty pull requests with small changes hence why Luis closed the PR. The changes look good overall so I've approved/merged them 👍 In the future you can add a description to your PR so that it's not auto-flagged 🙏

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
examples Issue/PR related to examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants