[docs][joy] Build API documentations #36008

hbjORbj · 2023-01-31T10:13:46Z

I have followed (at least) the PR section of the contributing guide.

Closes #35813

Summary of this PR:

Export Autocomplete, AutocompleteListbox, AutocompleteOption, ScopedCssBaseline
Typography: Add default value to levelMapping
Correct the default values of props in interfaces in multiple components
Create docs/translations/api-docs-joy where all JSON files for api docs of Joy components are located
Generate API docs for Joy (located in docs/pages/joy-ui/api)

Preview: https://deploy-preview-36008--material-ui.netlify.app/joy-ui/api/alert/ -> Alert API

mui-bot · 2023-01-31T10:16:32Z

Netlify deploy preview

@mui/joy: parsed: +0.51% , gzip: +0.64%

Bundle size report

Details of bundle changes

Generated by 🚫 dangerJS against 94597b5

docs/translations/api-docs/aspect-ratio/aspect-ratio.json

packages/mui-joy/src/Autocomplete/Autocomplete.tsx

packages/mui-joy/src/styles/index.ts

docs/data/joy/pages.ts

docs/pages/joy-ui/api/alert.js

docs/translations/api-docs-joy/color-inversion/color-inversion.json

docs/translations/translations.json

packages/api-docs-builder/buildApi.ts

mnajdova · 2023-02-07T11:54:01Z

packages/api-docs-builder/buildApi.ts

+              // Grid has problem with react-docgen
+              // Stack has problem with react-docgen


Is this still the case?

Yes, the inclusion of Grid and Stack are causing 3 throws of "No component definition found".

Alright, we can investigate this in a follow-up PR.

packages/api-docs-builder/utils/defaultPropsHandler.ts

packages/mui-joy/src/Container/Container.tsx

mnajdova · 2023-02-07T12:01:30Z

packages/mui-joy/src/Menu/MenuProps.ts

-       */
-      variant?: OverridableStringUnion<VariantProp, MenuPropsVariantOverrides>;
-    };
+  props: P & {


Is this required for the script to work correctly? Should we document it or try to fix the script if this is the case?

Yes, this fixed the following error:
color: Error: JSDoc @default annotation not found. Add @default 'neutral' to the JSDoc of this prop.

Even if MenuProps had @default 'neutral', it wasn't being copied to PropTypes in Menu.tsx.

Should we document it or try to fix the script if this is the case?

Agree

hbjORbj · 2023-02-07T12:14:57Z

@siriwatknp @mnajdova I will review the PR myself 1 more time and let you know. Don't review more yet please!

hbjORbj · 2023-02-09T11:48:48Z

@siriwatknp @mnajdova I think this is ready for review now!

Summary of this PR:

Export Autocomplete, AutocompleteListbox, AutocompleteOption, ScopedCssBaseline
Typography: Add default value to levelMapping
Correct the default values of props in interfaces in multiple components
Create docs/translations/api-docs-joy where all JSON files for api docs of Joy components are located
Generate API docs for Joy (located in docs/pages/joy-ui/api)

mnajdova

Two small nits from code perspective. I will test out the api pages a bit next.

docs/scripts/i18n.js

packages/api-docs-builder/buildApiUtils.ts

mnajdova

The CSS section is missing from the Joy's API pages, for e.g. this is how it looks for the Material UI's components: https://mui.com/material-ui/api/accordion/#css

hbjORbj · 2023-02-13T08:59:23Z

The CSS section is missing from the Joy's API pages, for e.g. this is how it looks for the Material UI's components: https://mui.com/material-ui/api/accordion/#css

Wouldn't it be more helpful for Joy package users if we release this PR and we work on CSS section in a separate PR?

mnajdova · 2023-02-13T09:02:28Z

Wouldn't it be more helpful for Joy package users if we release this PR and we work on CSS section in a separate PR?

That works too, I mentioned it so that it's not overlooked. Apart from that I can't find anything else that's missing. Great work Benny! I will let the last review to Jun, to validate that we have everything in place.

hbjORbj · 2023-02-13T09:16:38Z

TODOs to be done in separate PRs

[docs][joy] Build API documentations #36008 (comment)
CSS Section in API documentation -> UPDATE: We are doing "Slots" Section for Joy instead of "CSS" Section

hbjORbj changed the title ~~[docs][joy] Build API documentation~~ [docs][joy] Build API documentations Jan 31, 2023

hbjORbj self-assigned this Jan 31, 2023

hbjORbj force-pushed the joy/api-docs branch from 588840e to 58cf87a Compare January 31, 2023 10:21

hbjORbj added docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy labels Jan 31, 2023

hbjORbj changed the title ~~[docs][joy] Build API documentations~~ Draft: [docs][joy] Build API documentations Jan 31, 2023

hbjORbj added this to the Joy UI stable release milestone Jan 31, 2023

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 2, 2023

hbjORbj changed the title ~~Draft: [docs][joy] Build API documentations~~ [docs][joy] Build API documentations Feb 2, 2023

hbjORbj force-pushed the joy/api-docs branch from 59face1 to b863a02 Compare February 2, 2023 08:39

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 2, 2023

zannager requested a review from siriwatknp February 3, 2023 13:37

hbjORbj force-pushed the joy/api-docs branch from 82039a7 to a35f04a Compare February 6, 2023 08:45

hbjORbj mentioned this pull request Feb 6, 2023

[core] Improve logic for handling system component in API doc generation #36078

Closed

1 task

siriwatknp reviewed Feb 7, 2023

View reviewed changes

docs/translations/api-docs/aspect-ratio/aspect-ratio.json Outdated Show resolved Hide resolved

siriwatknp reviewed Feb 7, 2023

View reviewed changes

packages/mui-joy/src/Autocomplete/Autocomplete.tsx Show resolved Hide resolved

siriwatknp reviewed Feb 7, 2023

View reviewed changes

packages/mui-joy/src/styles/index.ts Outdated Show resolved Hide resolved

mnajdova reviewed Feb 7, 2023

View reviewed changes

hbjORbj requested review from mnajdova and siriwatknp February 9, 2023 11:49

hbjORbj force-pushed the joy/api-docs branch from 88b7127 to b26a5dd Compare February 9, 2023 12:05

hbjORbj mentioned this pull request Feb 13, 2023

[Joy] Remove classes prop from the components that have it #36159

Merged

1 task

mnajdova reviewed Feb 13, 2023

View reviewed changes

docs/scripts/i18n.js Show resolved Hide resolved

packages/api-docs-builder/buildApiUtils.ts Outdated Show resolved Hide resolved

mnajdova previously requested changes Feb 13, 2023

View reviewed changes

hbjORbj added 22 commits February 21, 2023 14:17

Ensure correct translation api directory is being used

26f2565

Run script (updating API doc files with correct translation directory)

84b62df

Restore box.js and stack.json in system/api folder

0abf5a4

manually add @default value for color prop in Menu

8e4bcf7

finalise

d1ea538

prettier

364d8e4

Run script

b56a99f

Revert the logic for handling system components

16d2566

Add joy-ui as a key to componentPackageMapping

0e8d642

Delete old docs

00535f6

Revert exporting ColorInversion

e2d52cd

prevent api doc generation for ListProvider

3e3baee

address code review comments

5e0141c

delete api-docs folder

546e498

add api-docs folder

b4e74f6

address comment

fa76cf7

remove unnecessary await

8123ce4

Add Component Name Section for joy as well

74cf3cb

update api docs

e7fbb18

update api doc of backdrop

cb6ec8d

update api docs

a4ab1d0

final changes after rebasing

94597b5

hbjORbj force-pushed the joy/api-docs branch from 73de918 to 94597b5 Compare February 21, 2023 14:21

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 21, 2023

hbjORbj enabled auto-merge (squash) February 21, 2023 14:55

hbjORbj disabled auto-merge February 21, 2023 16:00

hbjORbj merged commit 17f9fc6 into mui:master Feb 21, 2023

siriwatknp pushed a commit to mnajdova/material-ui that referenced this pull request Feb 24, 2023

[docs][joy] Build API documentations (mui#36008)

afa507c

This was referenced Mar 3, 2023

[docs] Fix 404 in the API page links #36419

Merged

[docs] Fix 404 links to customization Material UI APIs mui/mui-x#8200

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs][joy] Build API documentations #36008

[docs][joy] Build API documentations #36008

hbjORbj commented Jan 31, 2023 •

edited

mui-bot commented Jan 31, 2023 •

edited

mnajdova Feb 7, 2023

hbjORbj Feb 7, 2023

mnajdova Feb 8, 2023

mnajdova Feb 7, 2023

hbjORbj Feb 7, 2023

hbjORbj commented Feb 7, 2023

hbjORbj commented Feb 9, 2023

mnajdova left a comment

mnajdova left a comment

hbjORbj commented Feb 13, 2023

mnajdova commented Feb 13, 2023

hbjORbj commented Feb 13, 2023 •

edited

		// Grid has problem with react-docgen
		// Stack has problem with react-docgen

[docs][joy] Build API documentations #36008

[docs][joy] Build API documentations #36008

Conversation

hbjORbj commented Jan 31, 2023 • edited

mui-bot commented Jan 31, 2023 • edited

Netlify deploy preview

Bundle size report

mnajdova Feb 7, 2023

Choose a reason for hiding this comment

hbjORbj Feb 7, 2023

Choose a reason for hiding this comment

mnajdova Feb 8, 2023

Choose a reason for hiding this comment

mnajdova Feb 7, 2023

Choose a reason for hiding this comment

hbjORbj Feb 7, 2023

Choose a reason for hiding this comment

hbjORbj commented Feb 7, 2023

hbjORbj commented Feb 9, 2023

mnajdova left a comment

Choose a reason for hiding this comment

mnajdova left a comment

Choose a reason for hiding this comment

hbjORbj commented Feb 13, 2023

mnajdova commented Feb 13, 2023

hbjORbj commented Feb 13, 2023 • edited

hbjORbj commented Jan 31, 2023 •

edited

mui-bot commented Jan 31, 2023 •

edited

hbjORbj commented Feb 13, 2023 •

edited