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

docs: improve wording on some pages according to alex.js #11973

Merged
merged 1 commit into from
Apr 17, 2020

Conversation

vcapretz
Copy link
Contributor

closes #9537

PR for improving the docs to avoid condescending language.
Some cases can be very opinionated so I didn't change every suggestion was offered when running npx alex inside the repo (it tells to be careful about usage of "Hook" which in React context is justified and totally ok).

Check issue for more reference, but here are some of the inputs I acted on 😄

  • warning disabled may be insensitive, use turned off, has a disability, person with a disability, people with disabilities instead
  • warning Be careful with executes, it’s profane in some cases
  • warning simply may be insensitive, try not to use it
  • warning easily may be insensitive, try not to use it
  • warning just may be insensitive, try not to use it
  • warning Be careful with execute, it’s profane in some cases
  • Be careful with executed, it’s profane in some cases
  • warning special may be insensitive

Let me know if have other suggestions and thank you for the time reviewing this PR! 🎉

@vcapretz vcapretz requested a review from Timer as a code owner April 17, 2020 14:09
@ijjk
Copy link
Member

ijjk commented Apr 17, 2020

Stats from current PR

Default Server Mode (Decrease detected ✓)
General
zeit/next.js canary vcapretz/next.js docs-improvements Change
buildDuration 12.8s 13.2s ⚠️ +388ms
nodeModulesSize 55.5 MB 55.5 MB
Page Load Tests Overall decrease ⚠️
zeit/next.js canary vcapretz/next.js docs-improvements Change
/ failed reqs 0 0
/ total time (seconds) 2.251 2.226 -0.02
/ avg req/sec 1110.78 1123.19 ⚠️ +12.41
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.25 1.278 ⚠️ +0.03
/error-in-render avg req/sec 2000.71 1956.69 -44.02
Client Bundles (main, webpack, commons)
zeit/next.js canary vcapretz/next.js docs-improvements Change
main-HASH.js gzip 6.25 kB 6.25 kB
webpack-HASH.js gzip 746 B 746 B
de003c3a9d30..5e5e.js gzip 10.3 kB 10.3 kB
framework.a1..NSE.txt gzip 220 B 220 B
framework.a1..NSE.txt gzip 220 B 220 B
framework.HASH.js gzip 39 kB 39 kB
Overall change 56.7 kB 56.7 kB
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary vcapretz/next.js docs-improvements Change
main-HASH.module.js gzip 4.79 kB 4.79 kB
webpack-HASH..dule.js gzip 746 B 746 B
de003c3a9d30..dule.js gzip 6.85 kB 6.85 kB
framework.HA..dule.js gzip 39 kB 39 kB
Overall change 51.4 kB 51.4 kB
Legacy Client Bundles (polyfills)
zeit/next.js canary vcapretz/next.js docs-improvements Change
polyfills-HASH.js gzip 26.2 kB 26.2 kB
Overall change 26.2 kB 26.2 kB
Client Pages
zeit/next.js canary vcapretz/next.js docs-improvements Change
_app.js gzip 1.24 kB 1.24 kB
_error.js gzip 3.12 kB 3.12 kB
hooks.js gzip 664 B 664 B
index.js gzip 222 B 222 B
link.js gzip 2.06 kB 2.06 kB
routerDirect.js gzip 279 B 279 B
withRouter.js gzip 278 B 278 B
Overall change 7.86 kB 7.86 kB
Client Pages Modern
zeit/next.js canary vcapretz/next.js docs-improvements Change
_app.module.js gzip 602 B 602 B
_error.module.js gzip 2.09 kB 2.09 kB
hooks.module.js gzip 383 B 383 B
index.module.js gzip 223 B 223 B
link.module.js gzip 1.52 kB 1.52 kB
routerDirect..dule.js gzip 281 B 281 B
withRouter.m..dule.js gzip 278 B 278 B
Overall change 5.38 kB 5.38 kB
Client Build Manifests
zeit/next.js canary vcapretz/next.js docs-improvements 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 vcapretz/next.js docs-improvements Change
index.html gzip 929 B 929 B
link.html gzip 938 B 938 B
withRouter.html gzip 927 B 927 B
Overall change 2.79 kB 2.79 kB

Serverless Mode
General
zeit/next.js canary vcapretz/next.js docs-improvements Change
buildDuration 14.4s 13.9s -510ms
nodeModulesSize 55.5 MB 55.5 MB
Client Bundles (main, webpack, commons)
zeit/next.js canary vcapretz/next.js docs-improvements Change
main-HASH.js gzip 6.25 kB 6.25 kB
webpack-HASH.js gzip 746 B 746 B
de003c3a9d30..5e5e.js gzip 10.3 kB 10.3 kB
framework.a1..NSE.txt gzip 220 B 220 B
framework.a1..NSE.txt gzip 220 B 220 B
framework.HASH.js gzip 39 kB 39 kB
Overall change 56.7 kB 56.7 kB
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary vcapretz/next.js docs-improvements Change
main-HASH.module.js gzip 4.79 kB 4.79 kB
webpack-HASH..dule.js gzip 746 B 746 B
de003c3a9d30..dule.js gzip 6.85 kB 6.85 kB
framework.HA..dule.js gzip 39 kB 39 kB
Overall change 51.4 kB 51.4 kB
Legacy Client Bundles (polyfills)
zeit/next.js canary vcapretz/next.js docs-improvements Change
polyfills-HASH.js gzip 26.2 kB 26.2 kB
Overall change 26.2 kB 26.2 kB
Client Pages
zeit/next.js canary vcapretz/next.js docs-improvements Change
_app.js gzip 1.24 kB 1.24 kB
_error.js gzip 3.12 kB 3.12 kB
hooks.js gzip 664 B 664 B
index.js gzip 222 B 222 B
link.js gzip 2.06 kB 2.06 kB
routerDirect.js gzip 279 B 279 B
withRouter.js gzip 278 B 278 B
Overall change 7.86 kB 7.86 kB
Client Pages Modern
zeit/next.js canary vcapretz/next.js docs-improvements Change
_app.module.js gzip 602 B 602 B
_error.module.js gzip 2.09 kB 2.09 kB
hooks.module.js gzip 383 B 383 B
index.module.js gzip 223 B 223 B
link.module.js gzip 1.52 kB 1.52 kB
routerDirect..dule.js gzip 281 B 281 B
withRouter.m..dule.js gzip 278 B 278 B
Overall change 5.38 kB 5.38 kB
Client Build Manifests
zeit/next.js canary vcapretz/next.js docs-improvements 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 vcapretz/next.js docs-improvements Change
_error.js 558 kB 558 kB
404.html 4.18 kB 4.18 kB
hooks.html 3.81 kB 3.81 kB
index.js 558 kB 558 kB
link.js 594 kB 594 kB
routerDirect.js 587 kB 587 kB
withRouter.js 587 kB 587 kB
Overall change 2.89 MB 2.89 MB

Copy link
Member

@timneutkens timneutkens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great 💯 Thanks! Really awesome contribution 😌

@timneutkens timneutkens merged commit 26df018 into vercel:canary Apr 17, 2020
@vcapretz vcapretz deleted the docs-improvements branch April 17, 2020 14:44
@vercel vercel locked as resolved and limited conversation to collaborators Jan 31, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

More inclusive documentation for next.js
3 participants