[CdkScrollable] Add more documentation and demo examples
Open
area: cdk/scrolling
docs
help wanted
P4
- Dominant language
- TypeScript
- Stars
- 25k
- Forks
- 6.8k
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 91
Description
i'm trying to put together the [test](https://github.com/angular/material2/blob/master/src/cdk/scrolling/scroll-dispatcher.spec.ts) of how to put a "scrollspy" together.
but unfortunately i did not find any help in the [documentation](https://material.angular.io/cdk/scrolling/overview).
can you expect a user manual?
thanks!
Contributor guide
Research direction
Start with the linked scroll-dispatcher.spec.ts test and the CDK scrolling overview to identify the documented CdkScrollable and scrollspy use cases. Done means adding the requested user guidance and demo examples for assembling a scrollspy, with the documentation matching the demonstrated behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100