Files

Shahed Nasser 245e5c9a69 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>

2023-12-13 16:02:41 +02:00

app

chore: improve JS Client TSDoc comments (#5582 )

2023-11-09 12:51:17 +02:00

components

docs: generate documentation for UI components (#5849 )

2023-12-13 16:02:41 +02:00

css

docs: fix design issues (#5252 )

2023-09-29 17:17:24 +03:00

layouts/Divided

docs: create docs workspace (#5174 )

2023-09-21 20:57:15 +03:00

providers

docs: add AI Assistant (#5249 )

2023-10-05 11:10:44 +03:00

public

docs: create docs workspace (#5174 )

2023-09-21 20:57:15 +03:00

specs

chore(docs): Generated API Reference (#5662 )

2023-11-21 10:45:38 +00:00

types

docs: create docs workspace (#5174 )

2023-09-21 20:57:15 +03:00

utils

docs: generate documentation for UI components (#5849 )

2023-12-13 16:02:41 +02:00

.env.sample

docs: add AI Assistant (#5249 )

2023-10-05 11:10:44 +03:00

.eslintrc.js

docs: create docs workspace (#5174 )

2023-09-21 20:57:15 +03:00

.gitignore

docs: create docs workspace (#5174 )

2023-09-21 20:57:15 +03:00

.yarnrc.yml

docs: create docs workspace (#5174 )

2023-09-21 20:57:15 +03:00

mdx-components.tsx

docs: create docs workspace (#5174 )

2023-09-21 20:57:15 +03:00

next.config.mjs

docs: create docs workspace (#5174 )

2023-09-21 20:57:15 +03:00

package.json

docs: fix code block titles (#5733 )

2023-11-27 16:08:10 +00:00

postcss.config.js

docs: create docs workspace (#5174 )

2023-09-21 20:57:15 +03:00

README.md

docs: create docs workspace (#5174 )

2023-09-21 20:57:15 +03:00

tailwind.config.js

docs: create docs workspace (#5174 )

2023-09-21 20:57:15 +03:00

tsconfig.json

docs: create docs workspace (#5174 )

2023-09-21 20:57:15 +03:00

vercel.json

docs: general fixes for docs workspace (#5184 )

2023-09-22 12:25:48 +03:00

README.md

Medusa API Reference

The Medusa API Reference website is built with Next.js 13. You can learn more about contributing here.

Note About OpenAPI Specs

The OpenAPI Specs under the directory specs are automatically generated by our OAS CLI tool. So, contributions should be made in the files under packages/medusa/src/api instead of directly making changes to the generated spec files.