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

Feature : Components Documentation for "rest props" #68099

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from

Conversation

Vrishabhsk
Copy link
Contributor

What?

  • Extend the documentation for component which incorporate and allow rest props

Why?

Screenshots or screencast

Before After
Screenshot 2024-12-18 at 6 50 58 PM Screenshot 2024-12-18 at 6 45 09 PM

Copy link

github-actions bot commented Dec 18, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: Vrishabhsk <[email protected]>
Co-authored-by: mirka <[email protected]>
Co-authored-by: tyxla <[email protected]>
Co-authored-by: ciampo <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Member

@mirka mirka left a comment

Choose a reason for hiding this comment

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

Displaying it as a fake arg is kind of interesting!

We have some subtle concerns we need to balance here though, which are:

  • We can't do this in the props tables for subcomponents. Not a blocker, but something to think about.
  • As you can see in this file too, we're gradually migrating the component READMEs to auto-generated versions. So ideally we want one canonical source of this information, which we automatically display in multiple locations (e.g. README, Storybook).

So I'm thinking maybe we can put this information in a designated field in the docs-manifest.json, from which we can display it as a fake prop in Storybook and as a line in the auto-generated README. What do you think?

@Vrishabhsk Vrishabhsk requested a review from mirka December 26, 2024 09:45
@Mamaduka Mamaduka added [Type] Developer Documentation Documentation for developers [Package] Components /packages/components labels Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Components /packages/components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants