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>
This commit is contained in:
Shahed NasserandKasper Fabricius Kristensen authored and GitHub committed 2023-12-13 16:02:41 +02:00
1 parent edc49bfe1d
commit 245e5c9a69
288 files changed
+6029 -1447

No files matched your search

@@ -1,34 +0,0 @@
import { HookTable } from "@/components/hook-table"
import { HookDataMap } from "@/types/hooks"
const PromptPropsValues: HookDataMap = [
{
value: "title",
type: "string",
},
{
value: "description",
type: "string",
},
{
value: "verificationText",
type: "string",
description: "Text the user has to input in order to confirm the action",
},
{
value: "cancelText",
type: "string",
description: `Label for the Cancel button. Defaults to "Cancel".`,
},
{
value: "confirmText",
type: "string",
description: `Label for the Confirm button. Defaults to "Confirm".`,
},
]
const Props = () => {
return <HookTable props={PromptPropsValues} />
}
export default Props