docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
This commit is contained in:
Shahed Nasser
2023-09-21 20:57:15 +03:00
committed by GitHub
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,116 @@
# Namespace: internal
## Classes
- [AdminCreateUserRequest](../classes/internal-32.AdminCreateUserRequest.md)
- [AdminResetPasswordRequest](../classes/internal-32.AdminResetPasswordRequest.md)
- [AdminResetPasswordTokenRequest](../classes/internal-32.AdminResetPasswordTokenRequest.md)
- [AdminUpdateUserRequest](../classes/internal-32.AdminUpdateUserRequest.md)
## Type Aliases
### AdminCreateUserPayload
Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-32.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-32.md#createuserroles) }
#### Defined in
[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L31)
___
### AdminUpdateUserPayload
Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-32.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-32.md#updateuserroles) }
#### Defined in
[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L41)
___
### AdminUserRes
Ƭ **AdminUserRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> |
#### Defined in
medusa/dist/api/routes/admin/users/index.d.ts:6
___
### AdminUsersListRes
Ƭ **AdminUsersListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `users` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] |
#### Defined in
medusa/dist/api/routes/admin/users/index.d.ts:9
___
### CreateUserRoles
Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\`
#### Defined in
[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L28)
___
### CreateUserRolesEnum
Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-32.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-32.AdminCreateUserRequest.md)[``"role"``]\>
#### Defined in
[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L25)
___
### NoUndefined
Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L23)
___
### UpdateUserRoles
Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
#### Defined in
[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L39)
___
### UpdateUserRolesEnum
Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-32.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-32.AdminUpdateUserRequest.md)[``"role"``]\>
#### Defined in
[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L37)