asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: generate documentation for UI components (#5849)

Browse Source 
* 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 Nasser
2023-12-13 16:02:41 +02:00
committed by GitHub
parent edc49bfe1d
commit 245e5c9a69
288 changed files with 6029 additions and 1447 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs-util/packages/react-docs-generator/src/utils/empty-prop-descriptor.ts Normal file
View File

@@ -0,0 +1,8 @@
import { PropDescriptor } from "react-docgen/dist/Documentation.js"
export default function emptyPropDescriptor(propDescriptor: PropDescriptor) {
const objKeys = Object.keys(propDescriptor)
objKeys.forEach((key) => {
delete propDescriptor[key as keyof PropDescriptor]
})
}