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

docs(button): add components playgrounds #2530

Merged
merged 5 commits into from
Sep 14, 2022
Merged

docs(button): add components playgrounds #2530

merged 5 commits into from
Sep 14, 2022

Conversation

brandyscarney
Copy link
Member

Question: should we remove the tables / descriptions under some of the headings?

I left them there to keep the additional information, but maybe we should either have them or not?

@vercel
Copy link

vercel bot commented Sep 2, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
ionic-docs ✅ Ready (Inspect) Visit Preview Sep 14, 2022 at 2:17PM (UTC)

Copy link
Contributor

@sean-perkins sean-perkins left a comment

Choose a reason for hiding this comment

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

The playground examples look great to me 👍

Thoughts on eliminating the table sections and moving that information into the comment blocks in Ionic Framework, to be autogenerated as part of the "Properties" section?

This could help us prevent docs from becoming stale, since when introducing or removing property values in a feature, hopefully we would catch that the JSDoc comment was not updated with the new context.

Edit:

This also would help improve Intellisense Dx.

@brandyscarney
Copy link
Member Author

@sean-perkins That's a good idea. I will look into adding that into the framework before removing from here & merging.

Copy link
Contributor

@averyjohnston averyjohnston left a comment

Choose a reason for hiding this comment

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

LGTM aside from a couple nitpicks and moving the info in those tables to the generated docs 👍

static/usage/button/theming/colors/demo.html Outdated Show resolved Hide resolved
@brandyscarney
Copy link
Member Author

I removed the tables from the docs here and that info has been added to the properties themselves here: ionic-team/ionic-framework#25940

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants