[Feature Request] could you add the description of the components to the web-type.json file ?

[12rambau]

Problem to solve

I am building a bridge between python and vuetify so user can use them in their notebook and I am using the web-type.json file as a reference to catch all the attributes, slots and event available for each component. all the said attributes are documented but the components "description" section is empty for all of them.

here is the start o the said file to illustrate my point:

{
  "$schema": "http://json.schemastore.org/web-types",
  "framework": "vue",
  "name": "vuetify",
  "version": "3.11.7",
  "contributions": {
    "html": {
      "types-syntax": "typescript",
      "description-markup": "markdown",
      "tags": [
        {
          "name": "VAlert",
          "source": {
            "module": "./src/components/index.ts",
            "symbol": "VAlert"
          },
          "description": "",
          "doc-url": "https://vuetifyjs.com/api/v-alert",
          "attributes": [
            {
              "name": "title",
              "description": "Specify a title text for the component.",
              "doc-url": "https://vuetifyjs.com/api/VAlert#props",
              "value": {
                "kind": "expression",
                "type": "string"
              }
            }
          ]
        }
      ]
    }
  }
}

Proposed solution

I would be happy to make a PR if someone can point me to where this descriptions should be set

[KaelWD]

Classic // TODO from 6 years ago:

vuetify/packages/api-generator/src/web-types.ts

Line 64 in a4ee80e

description: '', // TODO: we should probably include component description in locale files

Locale files are https://github.com/vuetifyjs/vuetify/tree/a4ee80e96d0c07a487b1bd38a4a355cd51a22ea2/packages/api-generator/src/locale/en

[12rambau]

that sounds like a decent first issue, can you assign it to me ? I will need it anyway for my python port