Docs: Fix broken links and typos, propose clarity improvements #1218
Conversation
IAmHopp
force-pushed
the
patch-1
branch
2 times, most recently
from
9ffb281 to
2a19461
Compare
|
@IAmHopp Thank you so much for doing this! 🎉 Let us know if we can help you with anything! |
Missing comma in hint-no-protocol-relative-urls.
Proposed improvement for conciseness in hint-no-friendly-error-pages.
|
Sure thing! Appreciate the support. I'll continue tomorrow. With any luck I won't swallow a bunch of commits accidently as I did today. |
Extraneous comma in hint-no-disallowed-headers
Extraneous comma in hint-no-html-only-headers.
Missing comma in hint-typescript-config/consistent-casing.
Missing comma in hint-typescript-config/import-helpers.
Missing comma in hint-typescript-config/no-comments.
Missing comma in hint-typescript-config/strict.
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| ## Why is this important? | |||
|
|
|||
| To avoid problems in your project, the webpack configuration has to be valid. | |||
| To avoid problems in your project, the webpack configuration must be valid. | |||
There was a problem hiding this comment.
I'm going to change this to needs to
| @@ -119,7 +119,7 @@ The possible values and the associated speeds for `connectionType` are: | |||
| | Edge | 240 Kbps | 200 Kbps | 840ms | | |||
| | Dial | 49 Kbps | 30 Kbps | 120ms | | |||
|
|
|||
| `loadTime` has to be a number greater than `1` and indicates the time in | |||
| `loadTime` must be a number greater than `1` and indicates the time in | |||
packages/hint-sri/README.md
Outdated
| @@ -27,7 +27,7 @@ This hint checks that a website correctly uses SRI, more specifically: | |||
|
|
|||
| * All the downloaded resources by an `<script>` or `<link rel="stylesheet">` | |||
| have an `integrity` attribute. | |||
| * [The `integrity` attribute has to be valid][sri format]. I.e.: it should | |||
| * [The `integrity` attribute must be valid][sri format]. I.e.: it should | |||
Also the new section in the link is Accessibility is Important for Individuals, Businesses, Society in case we want a more up to date quote. Thanks a lot for your work @IAmHopp ! |
|
Amazing! Glad I could help. I'll rebase and wrap this up tomorrow. |
Broken link in hint-highest-available-document-mode.
One of my changes included a fix inside of a quote from an external resource.
Proposed readability improvements in hint-performance-budget.
Fixes for product names specified with lowercase and an unmatched bracket.
Fixes an extraneous comma and improves cohesion inside of a bullet point declaration.
One change to improve conciseness and one to improve readability by removing a "browsers pages" collision.
Proposed change to improve conciseness.
Cohesion improvement in hint-http-compression.
Conforming to "and/or", which is most used elsewhere in the docs.
|
Alright, guys, One last case I want to report: The "Can the hint be configured?" section in hint-meta-viewport looks sort of broken. The information that's there seems to belong elsewhere, which, if true, would leave it devoid of content, of course. I think one of you should take a look. As for the other files, I think I'm done. Let me know if you need my help elsewhere. |
|
Thanks a lot @IAmHopp!
All the issues that don't have someone assigned are available that wants to do it and we can help in the process 😊 Re the
|
The information belongs there, but yes, it can be improved.
I'll start reviewing and merge this PR. Again, thank you so much for doing this, we sincerely appreciate it!. 💜 @IAmHopp Did you learn anything new going through the docs? |
| @@ -35,13 +35,13 @@ As for the charset meta tag, always use `<meta charset="utf-8">` as: | |||
| example]. The same may be true for other agents (non-browsers) that | |||
| may scan/get the content and may not have the alias. | |||
|
|
|||
| * Must be inside the `<head>` element and [within the first 1024 | |||
| * It must be inside the `<head>` element and [within the first 1024 | |||
Alright, I'll get on it before venturing into the code.
Sure! I had already read most of the pages before, but it was cool getting to know the whole thing. I'm quite fond of this project. |
Pull request checklist
Make sure you:
For non-trivial changes, please make sure you also:
Added/Updated related documentation.Added/Updated related tests.Short description of the change(s)
Since there were no objections in #1216, I'm going through each hint doc and checking for typos and suggesting minor changes for improved readability. If there are any objections, please let me know and I'll abandon the PR.
Files to review:
Once done:
Check files changed-- Vast majority of commits were merged ahead of time yesterday, so this wouldn't be valuable anymore.