docs: use descriptive links instead of "click here" #25897
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
Linking text such as "here" or "click here" is not accessible (and doesn't look that great either). The best example of why it's better to use link text that provides context is that some screen readers allow navigation by links alone. If all links say "click here", then how does the user know which one to go to? I tried to make the minimal change necessary to make the link text descriptive but had to reword a few sentences that didn't read well.
johnjago
requested review from
divmain,
ijjk,
leerob,
lfades,
shuding and
timneutkens
as code owners
leerob
reviewed
Jun 9, 2021
Stats from current PRDefault Server Mode (Increase detected
|
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| buildDuration | 14.5s | 14.3s | -181ms |
| buildDurationCached | 3.6s | 3.5s | -114ms |
| nodeModulesSize | 46.5 MB | 46.5 MB | ✓ |
Page Load Tests Overall increase ✓
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| / failed reqs | 0 | 0 | ✓ |
| / total time (seconds) | 3.005 | 2.92 | -0.08 |
| / avg req/sec | 831.82 | 856.12 | +24.3 |
| /error-in-render failed reqs | 0 | 0 | ✓ |
| /error-in-render total time (seconds) | 1.872 | 1.69 | -0.18 |
| /error-in-render avg req/sec | 1335.48 | 1479.36 | +143.88 |
Client Bundles (main, webpack, commons)
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| framework-HASH.js gzip | 39.3 kB | 39.3 kB | ✓ |
| main-HASH.js gzip | 20.2 kB | 20.2 kB | ✓ |
| webpack-HASH.js gzip | 804 B | 804 B | ✓ |
| Overall change | 60.3 kB | 60.3 kB | ✓ |
Legacy Client Bundles (polyfills)
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| polyfills-HASH.js gzip | 31.1 kB | 31.1 kB | ✓ |
| Overall change | 31.1 kB | 31.1 kB | ✓ |
Client Pages
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| _app-HASH.js gzip | 801 B | 801 B | ✓ |
| _error-HASH.js gzip | 3.07 kB | 3.07 kB | ✓ |
| amp-HASH.js gzip | 527 B | 527 B | ✓ |
| css-HASH.js gzip | 334 B | 334 B | ✓ |
| hooks-HASH.js gzip | 890 B | 890 B | ✓ |
| index-HASH.js gzip | 263 B | 263 B | ✓ |
| link-HASH.js gzip | 1.64 kB | 1.64 kB | ✓ |
| routerDirect..HASH.js gzip | 333 B | 333 B | ✓ |
| withRouter-HASH.js gzip | 330 B | 330 B | ✓ |
| bb14e60e810b..30f.css gzip | 125 B | 125 B | ✓ |
| Overall change | 8.31 kB | 8.31 kB | ✓ |
Client Build Manifests
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| _buildManifest.js gzip | 392 B | 392 B | ✓ |
| Overall change | 392 B | 392 B | ✓ |
Rendered Page Sizes
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| index.html gzip | 572 B | 572 B | ✓ |
| link.html gzip | 581 B | 581 B | ✓ |
| withRouter.html gzip | 568 B | 568 B | ✓ |
| Overall change | 1.72 kB | 1.72 kB | ✓ |
Serverless Mode
General
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| buildDuration | 16.2s | 16.3s | |
| buildDurationCached | 4.7s | 4.7s | -19ms |
| nodeModulesSize | 46.5 MB | 46.5 MB | ✓ |
Client Bundles (main, webpack, commons)
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| framework-HASH.js gzip | 39.3 kB | 39.3 kB | ✓ |
| main-HASH.js gzip | 20.2 kB | 20.2 kB | ✓ |
| webpack-HASH.js gzip | 804 B | 804 B | ✓ |
| Overall change | 60.3 kB | 60.3 kB | ✓ |
Legacy Client Bundles (polyfills)
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| polyfills-HASH.js gzip | 31.1 kB | 31.1 kB | ✓ |
| Overall change | 31.1 kB | 31.1 kB | ✓ |
Client Pages
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| _app-HASH.js gzip | 801 B | 801 B | ✓ |
| _error-HASH.js gzip | 3.07 kB | 3.07 kB | ✓ |
| amp-HASH.js gzip | 527 B | 527 B | ✓ |
| css-HASH.js gzip | 334 B | 334 B | ✓ |
| hooks-HASH.js gzip | 890 B | 890 B | ✓ |
| index-HASH.js gzip | 263 B | 263 B | ✓ |
| link-HASH.js gzip | 1.64 kB | 1.64 kB | ✓ |
| routerDirect..HASH.js gzip | 333 B | 333 B | ✓ |
| withRouter-HASH.js gzip | 330 B | 330 B | ✓ |
| bb14e60e810b..30f.css gzip | 125 B | 125 B | ✓ |
| Overall change | 8.31 kB | 8.31 kB | ✓ |
Client Build Manifests
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| _buildManifest.js gzip | 392 B | 392 B | ✓ |
| Overall change | 392 B | 392 B | ✓ |
Serverless bundles
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| _error.js | 16.9 kB | 16.9 kB | ✓ |
| 404.html | 2.44 kB | 2.44 kB | ✓ |
| 500.html | 2.43 kB | 2.43 kB | ✓ |
| amp.amp.html | 10.8 kB | 10.8 kB | ✓ |
| amp.html | 1.63 kB | 1.63 kB | ✓ |
| css.html | 1.81 kB | 1.81 kB | ✓ |
| hooks.html | 1.69 kB | 1.69 kB | ✓ |
| index.js | 17.2 kB | 17.2 kB | ✓ |
| link.js | 17.4 kB | 17.4 kB | ✓ |
| routerDirect.js | 17.4 kB | 17.4 kB | ✓ |
| withRouter.js | 17.4 kB | 17.4 kB | ✓ |
| Overall change | 107 kB | 107 kB | ✓ |
Webpack 4 Mode (Increase detected ⚠️ )
General
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| buildDuration | 12.8s | 12.8s | -26ms |
| buildDurationCached | 5.2s | 5.3s | |
| nodeModulesSize | 46.5 MB | 46.5 MB | ✓ |
Page Load Tests Overall increase ✓
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| / failed reqs | 0 | 0 | ✓ |
| / total time (seconds) | 2.935 | 2.981 | |
| / avg req/sec | 851.84 | 838.61 | |
| /error-in-render failed reqs | 0 | 0 | ✓ |
| /error-in-render total time (seconds) | 1.688 | 1.653 | -0.03 |
| /error-in-render avg req/sec | 1480.61 | 1512.13 | +31.52 |
Client Bundles (main, webpack, commons)
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| 677f882d2ed8..HASH.js gzip | 13.4 kB | 13.4 kB | ✓ |
| framework.HASH.js gzip | 39 kB | 39 kB | ✓ |
| main-HASH.js gzip | 7.99 kB | 7.99 kB | ✓ |
| webpack-HASH.js gzip | 751 B | 751 B | ✓ |
| Overall change | 61.1 kB | 61.1 kB | ✓ |
Legacy Client Bundles (polyfills)
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| polyfills-HASH.js gzip | 31.3 kB | 31.3 kB | ✓ |
| Overall change | 31.3 kB | 31.3 kB | ✓ |
Client Pages
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| _app-HASH.js gzip | 1.07 kB | 1.07 kB | ✓ |
| _error-HASH.js gzip | 3.74 kB | 3.74 kB | ✓ |
| amp-HASH.js gzip | 536 B | 536 B | ✓ |
| css-HASH.js gzip | 339 B | 339 B | ✓ |
| hooks-HASH.js gzip | 887 B | 887 B | ✓ |
| index-HASH.js gzip | 227 B | 227 B | ✓ |
| link-HASH.js gzip | 1.63 kB | 1.63 kB | ✓ |
| routerDirect..HASH.js gzip | 303 B | 303 B | ✓ |
| withRouter-HASH.js gzip | 302 B | 302 B | ✓ |
| e025d2764813..52f.css gzip | 125 B | 125 B | ✓ |
| Overall change | 9.17 kB | 9.17 kB | ✓ |
Client Build Manifests
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| _buildManifest.js gzip | 420 B | 420 B | ✓ |
| Overall change | 420 B | 420 B | ✓ |
Rendered Page Sizes
| vercel/next.js canary | johnjago/next.js docs-here-link | Change | |
|---|---|---|---|
| index.html gzip | 626 B | 626 B | ✓ |
| link.html gzip | 632 B | 632 B | ✓ |
| withRouter.html gzip | 619 B | 619 B | ✓ |
| Overall change | 1.88 kB | 1.88 kB | ✓ |
|
Thank you @leerob for resolving the suggestions you made! I agree with your changes. It looks like the Azure integration build is failing, but as far as I can tell it's not related to this PR. |
ijjk
approved these changes
Jun 9, 2021
flybayer
pushed a commit
to blitz-js/next.js
that referenced
this pull request
Jun 16, 2021
* docs: use descriptive links instead of "click here" Linking text such as "here" or "click here" is not accessible (and doesn't look that great either). The best example of why it's better to use link text that provides context is that some screen readers allow navigation by links alone. If all links say "click here", then how does the user know which one to go to? I tried to make the minimal change necessary to make the link text descriptive but had to reword a few sentences that didn't read well. * Apply suggestions from code review Co-authored-by: Lee Robinson <me@leerob.io> Co-authored-by: JJ Kasper <jj@jjsweb.site>
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.
Linking text such as "here" or "click here" is not accessible (and
doesn't look that great either). The best example of why it's better to
use link text that provides context is that some screen readers allow
navigation by links alone. If all links say "click here", then how does
the user know which one to go to?
I tried to make the minimal change necessary to make the link text
descriptive but had to reword a few sentences that didn't read well.
References:
Bug
fixes #numberFeature
fixes #numberDocumentation / Examples