Skip to content

docs(select): add basic readme #2438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Jan 5, 2017
Merged

docs(select): add basic readme #2438

merged 2 commits into from
Jan 5, 2017

Conversation

kara
Copy link
Contributor

@kara kara commented Dec 28, 2016

Closes #2148

@kara kara requested a review from jelbourn December 28, 2016 02:47
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Dec 28, 2016
@jelbourn
Copy link
Member

Can you add documentation to the OVERVIEW.md too? That's where the docs on material.angular.io are generated from.

@kara kara force-pushed the select-docs branch 2 times, most recently from 26b7cb4 to 1dbb680 Compare December 28, 2016 18:33
@kara
Copy link
Contributor Author

kara commented Dec 28, 2016

@jelbourn Updated with overview!

jelbourn
jelbourn reviewed Jan 5, 2017
View reviewed changes
src/lib/select/OVERVIEW.md

<!-- example(select-overview) -->
Copy link
Member

Choose a reason for hiding this comment

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

This comment needs to stay. This is what embeds the live example on the docs site.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oopsies

src/lib/select/README.md
`<md-select>` is a form control for selecting a value from a set of options, similar to the native
Copy link
Member

Choose a reason for hiding this comment

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

FYI, I plan on wiping out all of the README files soon (and just pointing to the docs site)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, submitted before we had that conversation. Want me to wipe now?

Copy link
Member

Choose a reason for hiding this comment

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

Doesn't matter to me; might as well keep it before we wipe them all.

@jelbourn
Copy link
Member

jelbourn commented Jan 5, 2017

LGTM

@kara kara added the action: merge The PR is ready for merge by the caretaker label Jan 5, 2017
@kara kara merged commit fc6fc25 into angular:master Jan 5, 2017
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jelbourn jelbourn jelbourn left review comments

Assignees
No one assigned
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

md-select is missing "Read Me" docs
3 participants
@kara @jelbourn @googlebot