This repository was archived by the owner on Dec 18, 2024. It is now read-only.
feat: add summaries to all menu items and category pages #512
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.
This PR adds short (max. two-line) summaries to all list cards across the documentation to provide more context to the user before they navigate to the documentation. A short paragraph is also added at the top of the two category list pages ("Components"/"CDK") to provide some context to those.
Currently I feel like there is not enough information on the documentation list pages to A) explain where you are and B) hint at where you want to go. This means that users could be sent a link like https://material.angular.io/cdk/categories and have the following questions:
Alternatively, they may visit https://material.angular.io/components/categories and be unsure what to expect when they click one of the child items. Will "Layout" contain components for structuring pages at the top-level, such as a sidebar, or will that be in "Navigation"?
I was surprised to see while writing this PR that there used to be a summary field for the categories but this was removed in 5d7429d. Was there a particular reason for this?
I don't expect that much of the content of these descriptions to make it through to the site unchanged but would love it to start a discussion about how to make the menu pages more contextualised.