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

Incomplete information for Accept-CH page #1408

Closed
summercms opened this issue Jan 17, 2021 · 16 comments · Fixed by #4907
Closed

Incomplete information for Accept-CH page #1408

summercms opened this issue Jan 17, 2021 · 16 comments · Fixed by #4907
Assignees
Labels
Content:HTTP HTTP docs effort: medium This task is a medium effort.

Comments

@summercms
Copy link

Related to this location: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-CH

This page is missing a huge amount of data, it seems to only cover:

  • DPR
  • Viewport Width
  • Width

Yet Client Hints cover a lot more, such as:

  • Device Memory
  • Rtt
  • Downlink
  • Ect
  • Save-Data
    etc.

I would like to see the MDN team update the information on the page to add these extra Client Hints and also update the Browser compatibility table.

Thanks.

@hamishwillee
Copy link
Collaborator

The page doesn't attempt to document everything - it links to the Client Hints glossary item where you are supposed to get information about all the headers it might work with.

I think the approach is right, but it should instead link to the list of supported headers at HTTP/Headers#client_hints.

The current list of headers on that page is: Accept-CH, Accept-CH-Lifetime ,Early-Data, Device-Memory, Save-Data, Viewport-Width, Width

So it is missing DPR and Downlink.

@ayumi-cloud What other ones do you know about?

Once we have a list we can update that page, and also look at the BCD for ACCEPT_CH

@hamishwillee hamishwillee self-assigned this Jan 19, 2021
@summercms
Copy link
Author

summercms commented Jan 19, 2021

@hamishwillee

What other ones do you know about?

See here: https://wicg.github.io/client-hints-infrastructure/#find-client-hint-value-section

There is also Lang Client Hint which has been deprecated, not sure if you want to also mention that in MDN?

I can't see any info about RTT

Use this info: https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/client-hints#rtt

I find that page useful about the blockquotes talking about fingerprinting, in the rtt case:

Note: The value of RTT is rounded to the nearest 25 milliseconds to prevent fingerprinting.

Is the Early-Data a client hint? I thought it was a separate thing like 103 Early Hints

Thanks.

@Ryuno-Ki
Copy link
Collaborator

There is also Lang Client Hint which has been deprecated, not sure if you want to also mention that in MDN?

In my observation, those things tend to be mentioned, but also marked as deprecated.
This way, it will become discoverable but also inform, that it shouldn't be used.

@hamishwillee
Copy link
Collaborator

Thanks. Hope to start thinking about this on Monday.

@hamishwillee
Copy link
Collaborator

FYI I am not ignoring this, and happy for someone to take it on. Just "time poor". I will get to it at some point.

@hamishwillee
Copy link
Collaborator

Reopening. Still got some bits to do: #4907 (comment)

@hamishwillee hamishwillee reopened this Jun 4, 2021
@summercms
Copy link
Author

summercms commented Jun 4, 2021

@hamishwillee
Copy link
Collaborator

Thanks @summercms . Do the above meet the requirement for documentation here: https://developer.mozilla.org/en-US/docs/MDN/Guidelines/Conventions_definitions#when_to_document_new_technologies ?

We also have to consider these cases: #4907 (comment)

Anyway, if there are new whole "collections" like these then probably wroth having separate issues for each (once verified it is time to document them). The work could be shared better that way.

@summercms
Copy link
Author

@hamishwillee

You should definitely consider documenting a new technology if:

  • It is specified in a specification document published under a reliable standards organization (such as W3C, WHATWG, Khronos, IETF, etc.), which has reached a reasonable level of stability (e.g. a W3C working draft or candidate recommendation, or the spec is looking to be fairly stable judging by the flow of issues filed against it).

Both are under Web Incubator CG (WICG)

  • It is implemented consistently in at least one browser, with other browser developers showing signs of interest (such as an active ticket or "intent to implement" process in effect).

Both are currently being added to Google Chrome.


Can open two separate issues for each - let me know and I can open 2 issues.

I have seen lately many new client hints being developed on the web, so MDN would probably like to add each one under a separate page to keep the doc's clean and not end up with a huge wall of text in the near future.

@hamishwillee
Copy link
Collaborator

FYI, slow progress, but I have nearly updated docs/BCD for the original headers in MDN. Some of these are now deprecated and have been replaced by Responsive Image Client Hints - but those aren't yet in any browsers.

Next start thinking about these other new ones.

@hamishwillee
Copy link
Collaborator

hamishwillee commented Jun 22, 2021

@summercms Regarding #1408 (comment), My interpretation is that neither of these are ready for documentation.
The relevant restriction is: and is implemented somewhere. Being in development is not good enough. To avoid having lots of churn on docs while a spec is still being "hardened" by real use, we wait until it is in a release build and there is some interest from other browsers. Often appearance in browser compatibility data is another good trigger.

For the same reason I won't be documenting Responsive Image Client Hints yet. However I have asked about the User agent client hints talked about here, because they went into Chrome 89https://www.chromestatus.com/feature/5995832180473856

@chris-schra
Copy link

Sorry for chiming in with a naive question, but why is CH Width marked deprecated? I can‘t find any references saying it is deprecated

@hamishwillee
Copy link
Collaborator

@chris-makaio If you mean https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Width , it is no longer in any current spec. It has been superseded in another spec, but the replacement has not yet appeared in any browser.

@github-actions github-actions bot added the idle label Dec 3, 2021
@himanshugarg
Copy link
Contributor

Are more fixes expected here? The linked PR is merged.

@sideshowbarker
Copy link
Collaborator

Closing per #1408 (comment)

@hamishwillee
Copy link
Collaborator

Thanks guys - yes this was done, module minor changes around a Save-Data change that has not yet landed in any browser.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 4, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:HTTP HTTP docs effort: medium This task is a medium effort.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants