docs: generate documentation for UI components (#5849)

* added tool to generate spec files for React components

* use typedoc for missing descriptions and types

* improvements and fixes

* improvements

* added doc comments for half of the components

* add custom resolver + more doc comments

* added all tsdocs

* general improvements

* add specs to UI docs

* added github action

* remove unnecessary api route

* Added readme for react-docs-generator

* remove comment

* Update packages/design-system/ui/src/components/currency-input/currency-input.tsx

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>

* remove description of aria fields + add generate script

---------

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>

packages/design-system/ui/src/components/heading/heading.tsx

@@ -17,11 +17,22 @@ const headingVariants = cva({
   },
 })
 
-type HeadingProps = VariantProps<typeof headingVariants> &
-  React.HTMLAttributes<HTMLHeadingElement>
+interface HeadingProps extends VariantProps<typeof headingVariants>,
+  React.HTMLAttributes<HTMLHeadingElement> {}
 
-const Heading = ({ level, className, ...props }: HeadingProps) => {
-  const Component = level ? level : "h1"
+/**
+ * This component is based on the heading element (`h1`, `h2`, etc...) depeneding on the specified level
+ * and supports all of its props
+ */
+const Heading = ({ 
+  /**
+   * The heading level which specifies which heading element is used.
+   */
+  level = "h1", 
+  className, 
+  ...props
+}: HeadingProps) => {
+  const Component = level || "h1"
 
   return (
     <Component