[docs-infra] Type interface API pages

[alexfauquette]

Follow up of mui/material-ui#43128

This is the opportunity to find incosistency about description and fix them.

Available slots for description

1. The meta data (the one displayed on google search)
2. Just after the page H1 title
3. Just before props definitions

Illustration

Available descriptions

a. A generic description with a placeholder for the component name:

API reference docs for the React {{componentName}} component. Learn about the props, CSS, and other APIs of this exported module."

b. The custom description from the JSDocs of the component (when provided)

Current behavior

On component API

1. a (generic def)
2. a (generic def)
3. b (custome def)

On interface API

1. a (generic def) with wrong content 🙈
2. b (custom def)
3. Nothing

Proposal

• Fix the generic definition with the following sentence (replacing props and classes by "properties")

  API reference docs for the {{name}} interface. Learn about the properties other APIs of this exported module.

• Follow the same patern as the API page of other components

[mui-bot]

Deploy preview: https://deploy-preview-14138--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against 3cafec7

[JCQuintas]

I don't know why types are not found for stuff imported from 'docs/src/...' but should not be an issue when moved to the @mui/docs package

Which types do you mean?

[alexfauquette]

The one I import from @mui/monorepo/docs/ instead of docs/

But not an issue since those stuff will move to the docs package

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.

[bharatkashyap]

Wondering what componentDescription was used for - is it okay to discard completely?

[alexfauquette]

Yes, component descript does not exist for interfaces. It has interfaceDescription which is already used a bit above in

<Typography
  variant="h5"
  component="p"
  className="description"
  gutterBottom
  dangerouslySetInnerHTML={{ __html: interfaceDescription }}
/>

It's visible for example in GridActionsColDef API

I replace the usual API page description

API reference docs for the React {{componentName}} component. Learn about the props, CSS, and other APIs of this exported module.

But that could probably be improved. I will check with other X memebers what they want for this page

[JCQuintas]

Maybe have the default be something like:

Suggested change

	"interfacePageDescription": "API reference docs for the {{name}} interface. Learn about the properties other APIs of this exported module."
	"interfacePageDescription": "Extended documentation for the {{name}} interface with detailed information on the module's properties and available APIs."

[flaviendelangle]

Is there a reason not to have a plan?: 'pro' | 'premium' | 'community' here?

[alexfauquette]

No other reason than "that's what the script returns"

I tried to do the update, but that would require a PR on the core repo to update properties section component

https://github.com/mui/material-ui/blob/master/docs/src/modules/components/ApiPage/sections/PropertiesSection.tsx/#L66-L69

[flaviendelangle]

Would probably make sense to update it at some point, but it's out of the scope of this PR then 👍