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

chore: adds component prop documentation #2541

Closed
wants to merge 34 commits into from

Conversation

nicholasrice
Copy link
Contributor

@nicholasrice nicholasrice commented Dec 31, 2019

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:

  1. Fix function signature output in component API documentation #2542 - Function signatures are not detailed - the type dispalyed is simply "function" instead of a detailed signature, eg (value: boolean) => string
  2. All components should have prop data in API docs #2543 - Some components interfaces have no prop data - this is because TypeDoc is unable to correctly document some of the more advanced types we use. I think we can
    closes Integrate typedoc utility into component documentation page #297
  3. Select's API data produces malformed JSX #2544 - For some reason the Select component's markdown is producing malformed JSX when run through the .md -> .jsx processor, so this component's API has been omitted from the component-explorer for the time being. I think this may be address when feat: adds fast-react-jss-manager project #2 is addressed but we'll have to see.

Motivation & context

Issue type checklist

  • Chore: A change that does not impact distributed packages.
  • Bug fix: A change that fixes an issue, link to the issue above.
  • New feature: A change that adds functionality.

Is this a breaking change?

  • This change causes current functionality to break.

Process & policy checklist

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

@nicholasrice nicholasrice force-pushed the users/nirice/typedoc-api-extractor branch from ec470cb to ab41baf Compare January 4, 2020 00:06
@nicholasrice nicholasrice force-pushed the users/nirice/typedoc-api-extractor branch from 2f6214d to cee4103 Compare January 15, 2020 16:29
@nicholasrice nicholasrice force-pushed the users/nirice/typedoc-api-extractor branch from 94362ec to 147dc4f Compare January 27, 2020 17:11
@stale
Copy link

stale bot commented Feb 11, 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 stale bot added the warning:stale No recent activity within a reasonable amount of time label Feb 11, 2020
@stale stale bot closed this Feb 18, 2020
@janechu janechu deleted the users/nirice/typedoc-api-extractor branch June 14, 2024 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
warning:stale No recent activity within a reasonable amount of time
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Integrate typedoc utility into component documentation page
4 participants