refactor(content-{blog,docs}): unify handling of tags #7117
Conversation
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site settings. |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-7117--docusaurus-2.netlify.app/ |
|
Size Change: -127 B (0%) Total Size: 804 kB
ℹ️ View Unchanged
|
| @@ -137,7 +137,7 @@ export function toTagDocListProp({ | |||
| }: { | |||
| allTagsPath: string; | |||
| tag: VersionTag; | |||
| docs: Pick<DocMetadata, 'id' | 'title' | 'description' | 'permalink'>[]; | |||
There was a problem hiding this comment.
as far as I remember the goal here was to avoid adding all docs attributes to tag pages as only a few attributes are displayed there => reduce tag page load time
in practice it seems doc props were not filtered, so each tag list page receives much more data than it really needs
There was a problem hiding this comment.
They are always filtered? See the code below. It's just that the function's argument is actually the full doc metadata
There was a problem hiding this comment.
Ah 🤪 misread the fn signature
Breaking change
Tags-related theme components have their props changed. Most notably,
namehas been renamed aslabelto align with its server-side metadata.Motivation
We have a lot of duplicated types that only differ slightly. I take this chance to make the tags-related data structures more re-used and more unified between the blog and docs.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
All pages still behave as before