-
Notifications
You must be signed in to change notification settings - Fork 600
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
chore: adds component prop documentation #2541
Closed
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nicholasrice
requested review from
awentzel,
chrisdholt and
janechu
as code owners
December 31, 2019 22:23
janechu
approved these changes
Jan 3, 2020
nicholasrice
force-pushed
the
users/nirice/typedoc-api-extractor
branch
from
January 4, 2020 00:06
ec470cb
to
ab41baf
Compare
nicholasrice
force-pushed
the
users/nirice/typedoc-api-extractor
branch
from
January 15, 2020 16:29
2f6214d
to
cee4103
Compare
scomea
approved these changes
Jan 16, 2020
nicholasrice
force-pushed
the
users/nirice/typedoc-api-extractor
branch
from
January 27, 2020 17:11
94362ec
to
147dc4f
Compare
chrisdholt
approved these changes
Jan 27, 2020
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
stale
bot
added
the
warning:stale
No recent activity within a reasonable amount of time
label
Feb 11, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This change introduces a mechanism to extract component prop data from TypeScript types and joins that information into a markdown file detailing unhandledProp, handledProp, and classNameContract interfaces (as well as supporting types) for all MSFT components. These markdown files are surfaced in the storybook innerloop site, as well as in the component explorer.
There are a few follow-up items:
closes Integrate typedoc utility into component documentation page #297
Motivation & context
Issue type checklist
Is this a breaking change?
Process & policy checklist