google / google/material-design-lite

Documentation layout rework

Open
#1,824 8 comments 0 reactions 0 assignees View on GitHub
Documentation Documentation Revamp
Dominant language
HTML
Stars
32.2k
Forks
4.9k
PR merge metrics
No merged PRs in 30d

Description

Our pages are too long-running, and the content is poorly organised. We should prepare some mockups and revamp the general layout. Some ideas to consider:
- One page per component, rather than one page per category of components.
- Sub-navigation inside each page, to separate examples from class reference and JSDoc reference.
- Better usage of anchors to save history between components.
- Better layout for displaying examples, to avoid exceeding screen width in mobile.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.