Add Compression Dictionary Transport docs#38722
Merged
Conversation
Contributor
Collaborator
|
Thanks for contributing these great-looking docs! Would you consider making https://pr38722.review.mdn.allizom.net/en-US/docs/Glossary/Compression_dictionary_transport a guide page under https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides, instead of a glossary page? I think it would be a better fit there. The sweet spot for glossary pages is things that are:
So the use case for readers is really when they are reading something else and thinking "what does this term mean" and we can explain it relatively quickly and they can get back to what they were reading before. This looks much more like a usage guide: how to use a set of web platform features to accomplish a thing. This is a drive-by comment since the PR is already assigned to Hamish and Estelle, but since I have stuck my oar in I am happy to review the whole thing if they would like, or not, if they would prefer that :). |
Contributor
Author
|
Done! I was wondering where exactly to put all this guidance, since I agree it was stretching the Glossary beyond it's intent, but also doesn't have a single API to put this. Guides is a perfect place for it. |
pmeenan
reviewed
Mar 20, 2025
Contributor
pmeenan
left a comment
There was a problem hiding this comment.
LGTM, just a few tweaks.
files/en-us/web/http/guides/compression_dictionary_transport/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/http/guides/compression_dictionary_transport/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/http/guides/compression_dictionary_transport/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/http/guides/compression_dictionary_transport/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/http/reference/headers/accept-encoding/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/http/reference/headers/accept-encoding/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/http/reference/headers/available-dictionary/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/http/reference/headers/use-as-dictionary/index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Patrick Meenan <patmeenan@gmail.com>
Collaborator
|
@wbamberg Be my guest. I have unassigned me and assigned you as reviewer. First in best dressed |
wbamberg
reviewed
Mar 26, 2025
files/en-us/web/http/guides/compression_dictionary_transport/index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: wbamberg <will@bootbonnet.ca>
wbamberg
reviewed
Mar 31, 2025
Collaborator
wbamberg
left a comment
There was a problem hiding this comment.
I still had a few more comments, sorry! But this is really close.
files/en-us/web/http/reference/headers/content-encoding/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/http/reference/headers/available-dictionary/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/http/reference/headers/available-dictionary/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/http/reference/headers/use-as-dictionary/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/http/guides/compression_dictionary_transport/index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: wbamberg <will@bootbonnet.ca>
…ndex.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…ndex.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…ndex.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…ndex.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Contributor
Author
|
Thanks again for all your efforts on this @wbamberg ! Let me know if you spot anything else. |
wbamberg
reviewed
Apr 1, 2025
files/en-us/web/http/reference/headers/content-encoding/index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
wbamberg
reviewed
Apr 1, 2025
files/en-us/web/http/guides/compression_dictionary_transport/index.md
Outdated
Show resolved
Hide resolved
wbamberg
approved these changes
Apr 1, 2025
Collaborator
wbamberg
left a comment
There was a problem hiding this comment.
OK this looks great. Thank you for adding these docs, and for your patience with me!
cssinate
pushed a commit
to cssinate/content
that referenced
this pull request
Apr 11, 2025
* Add Compression Dictionary Transport docs * Move bulk of guidance to Guides * Apply suggestions from code review Co-authored-by: Patrick Meenan <patmeenan@gmail.com> * Review feedback * Review feedback - expand introduction * Add more details on format and compression examples * Tweaks * Request -> response * Tweaks * Code formatting file * Apply suggestions from code review Co-authored-by: Patrick Meenan <patmeenan@gmail.com> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md Co-authored-by: Patrick Meenan <patmeenan@gmail.com> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md Co-authored-by: Patrick Meenan <patmeenan@gmail.com> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md Co-authored-by: Patrick Meenan <patmeenan@gmail.com> * Add Link header example * Add note about HTTP Cache partitioning * Apply suggestions from code review Co-authored-by: wbamberg <will@bootbonnet.ca> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md Co-authored-by: wbamberg <will@bootbonnet.ca> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md Co-authored-by: wbamberg <will@bootbonnet.ca> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md Co-authored-by: wbamberg <will@bootbonnet.ca> * Clean up most delta-compressed to dictionary-compressed * Review feedback * Add note about SDCH * Move link to link->rel * Apply suggestions from code review Co-authored-by: wbamberg <will@bootbonnet.ca> * Link rel * Review feedback * grammar * Apply suggestions from code review Co-authored-by: wbamberg <will@bootbonnet.ca> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Linter broke things * Add back incorrectly removed identity * Update files/en-us/web/http/reference/headers/content-encoding/index.md * Update files/en-us/web/http/reference/headers/content-encoding/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update files/en-us/web/http/guides/compression_dictionary_transport/index.md --------- Co-authored-by: Patrick Meenan <patmeenan@gmail.com> Co-authored-by: wbamberg <will@bootbonnet.ca> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Description
Shared Compression Dictionary is a new standard to allow much smaller resource sizes by reusing either previous resources as dictionaries, or having a separate disctionary.
It is available using Brotli or the newer ZStd compression standards and has been available in Chrome since 130
This PR adds the relevant documentation.
Motivation
This feature is poorly documented at the moment outside of specs and GitHub repos.
Chrome wrote and old blog post on it, but the syntax changed a bit when it was launched:
https://developer.chrome.com/blog/shared-dictionary-compression
Rather then redo that, we'd rather document on MDN and point people from that post to here.
Additional details
https://chromestatus.com/feature/5124977788977152
Related issues and pull requests
BCD updates in mdn/browser-compat-data#26257