Skip to content

docs(material/core): Add a brief overview that refers users to the API docs #22773

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.

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

Merged
merged 1 commit into from
May 25, 2021

Conversation

mmalerba
Copy link
Contributor

@mmalerba mmalerba commented May 24, 2021

This will allow us to publish a section on the docs site for @angular/material/core.

Related to #8790

…I docs

This will allow us to publish a section on the docs site for
`@angular/material/core`.
@mmalerba mmalerba added docs This issue is related to documentation merge safe labels May 24, 2021
@mmalerba mmalerba requested a review from jelbourn May 24, 2021 17:39
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label May 24, 2021
@devversion
Copy link
Member

We have an exception for the ripples. I assume we want to keep that so that we can continue displaying it as a dedicated entry in the docs site?

One thing to acknowledge is that the ripple API would now also show up in the core entry. Though this might not be a problem.. just raising it here for awareness/discussion.

@mmalerba
Copy link
Contributor Author

We currently generate API docs for @angular/material/core but don't link to them anywhere. My plan was to create this overview doc just to have something to put in the overview tab so I can create an entry in the docs site for @angular/material/core. Here's what that would look like: https://material2-docs-dev.web.app/components/core/api, it doesn't seem to include the ripple docs, I guess those are extracted.

It's far from an ideal solution, but I think its better to show this information in a non-ideal format than just not show it at all. We can do future passes to organize it better

@devversion
Copy link
Member

devversion commented May 24, 2021

Here's what that would look like: https://material2-docs-dev.web.app/components/core/api, it doesn't seem to include the ripple docs, I guess those are extracted

Aha! you're right. looks line we're good here. Our Dgeni entry point grouper doesn't add the ripple exports to the core entry-point group, so that they only end up in the ripple group.

And yeah, agreed. Showing the core API docs sounds great to me (especially as a first step)

@mmalerba mmalerba added target: patch This PR is targeted for the next patch release action: merge The PR is ready for merge by the caretaker labels May 24, 2021
@wagnermaciel wagnermaciel merged commit 1305587 into angular:master May 25, 2021
wagnermaciel pushed a commit that referenced this pull request May 25, 2021
…I docs (#22773)

This will allow us to publish a section on the docs site for
`@angular/material/core`.

(cherry picked from commit 1305587)
@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 Jun 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement docs This issue is related to documentation target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants