Skip to content
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

Merged
merged 1 commit into from
Sep 5, 2018

Conversation

benelliott
Copy link
Contributor

@benelliott benelliott commented Aug 27, 2018

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:

  • What is the CDK? What does it stand for? Why would I use it instead of "normal" Angular Material?
  • What is in the "Components" menu item and how is that different from the "Components" button in the toolbar?

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.

@jelbourn
Copy link
Member

jelbourn commented Sep 4, 2018

This is great! It helps quite a lot. Looks good aside from needing a rebase; I may tweak some of the summaries in a follow-up PR.

@benelliott
Copy link
Contributor Author

@jelbourn Great, thanks! Rebased and added summaries for text-field and platform.

Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jelbourn jelbourn merged commit d15b77f into angular:master Sep 5, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants