fix(docs): forward doc frontMatter.sidebar_custom_props to linking sidebar category #7638
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.
Pre-flight checklist
Motivation
While investigating #7598, I realized that we don't always forward
sidebar_custom_props
to the sidebar elementIf a category has a doc link, then the doc
frontMatter.sidebar_custom_props
should be used as category customProps.This is consistent with the behavior we have for autogenerated sidebars already:
Test Plan
Quick fix, local test only.
I think
props.ts
andgenerator.ts
are not the ideal place to handle that. The "custom props forwarding" is spread across multiple parts of the codebase.We should probably refactor all that and handle all the custom props forwarding in
postProcessor.ts
, sharing the same logic between autogenerated items and explicit items. And add good tests there.Also maybe we want to merge custom props instead of
??
?Any opinion on that refactor @Josh-Cena ?