Skip to content

Commit 17401f1

Browse files
pkosiecpkosiec
committed
docs: generate API reference docs from TS packages
1 parent 7fc05c9 commit 17401f1

File tree

398 files changed

+12388
-15
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

398 files changed

+12388
-15
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ jobs:
3131
filters: |
3232
docs:
3333
- 'docs/**'
34+
- 'packages/**'
3435
appkit:
3536
- '!docs/**'
3637
@@ -97,4 +98,23 @@ jobs:
9798
run: pnpm install --frozen-lockfile
9899
- name: Build Docs
99100
run: pnpm run docs:build
101+
- name: Lint Generated Docs
102+
run: pnpm run docs:lint
103+
- name: Format Generated Docs
104+
run: pnpm run docs:format
105+
- name: Check for uncommitted docs changes
106+
run: |
107+
if ! git diff --exit-code docs/docs/api/; then
108+
echo "❌ Error: Generated docs are out of sync with the codebase."
109+
echo ""
110+
echo "The API documentation in docs/docs/api/ has changes after running docs:generate."
111+
echo "This means the committed docs don't match the current package code."
112+
echo ""
113+
echo "To fix this:"
114+
echo " 1. Run: pnpm docs:build"
115+
echo " 2. Run: pnpm docs:format"
116+
echo " 3. Review and commit the changes"
117+
echo ""
118+
exit 1
119+
fi
100120

‎biome.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616
"!**/coverage",
1717
"!packages/appkit-ui/src/react/ui",
1818
"!**/routeTree.gen.ts",
19-
"!docs/.docusaurus"
19+
"!docs/.docusaurus",
20+
"!**/typedoc-sidebar.ts"
2021
]
2122
},
2223
"formatter": {

‎docs/docs/api/app-kit-ui/functions/Accordion.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Function: Accordion()
2+
3+
```ts
4+
function Accordion(__namedParameters): Element;
5+
```
6+
7+
Defined in: [packages/app-kit-ui/src/react/ui/accordion.tsx:7](https://github.com/databricks/app-kit/blob/main/packages/app-kit-ui/src/react/ui/accordion.tsx#L7)
8+
9+
## Parameters
10+
11+
| Parameter | Type |
12+
| ------ | ------ |
13+
| `__namedParameters` | `AccordionSingleProps` \| `AccordionMultipleProps` & `RefAttributes`\<`HTMLDivElement`\> |
14+
15+
## Returns
16+
17+
`Element`

‎docs/docs/api/app-kit-ui/functions/AccordionContent.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Function: AccordionContent()
2+
3+
```ts
4+
function AccordionContent(__namedParameters): Element;
5+
```
6+
7+
Defined in: [packages/app-kit-ui/src/react/ui/accordion.tsx:48](https://github.com/databricks/app-kit/blob/main/packages/app-kit-ui/src/react/ui/accordion.tsx#L48)
8+
9+
## Parameters
10+
11+
| Parameter | Type |
12+
| ------ | ------ |
13+
| `__namedParameters` | `AccordionContentProps` & `RefAttributes`\<`HTMLDivElement`\> |
14+
15+
## Returns
16+
17+
`Element`

‎docs/docs/api/app-kit-ui/functions/AccordionItem.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Function: AccordionItem()
2+
3+
```ts
4+
function AccordionItem(__namedParameters): Element;
5+
```
6+
7+
Defined in: [packages/app-kit-ui/src/react/ui/accordion.tsx:13](https://github.com/databricks/app-kit/blob/main/packages/app-kit-ui/src/react/ui/accordion.tsx#L13)
8+
9+
## Parameters
10+
11+
| Parameter | Type |
12+
| ------ | ------ |
13+
| `__namedParameters` | `AccordionItemProps` & `RefAttributes`\<`HTMLDivElement`\> |
14+
15+
## Returns
16+
17+
`Element`

‎docs/docs/api/app-kit-ui/functions/AccordionTrigger.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Function: AccordionTrigger()
2+
3+
```ts
4+
function AccordionTrigger(__namedParameters): Element;
5+
```
6+
7+
Defined in: [packages/app-kit-ui/src/react/ui/accordion.tsx:26](https://github.com/databricks/app-kit/blob/main/packages/app-kit-ui/src/react/ui/accordion.tsx#L26)
8+
9+
## Parameters
10+
11+
| Parameter | Type |
12+
| ------ | ------ |
13+
| `__namedParameters` | `AccordionTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> |
14+
15+
## Returns
16+
17+
`Element`

‎docs/docs/api/app-kit-ui/functions/Alert.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Function: Alert()
2+
3+
```ts
4+
function Alert(__namedParameters): Element;
5+
```
6+
7+
Defined in: [packages/app-kit-ui/src/react/ui/alert.tsx:22](https://github.com/databricks/app-kit/blob/main/packages/app-kit-ui/src/react/ui/alert.tsx#L22)
8+
9+
## Parameters
10+
11+
| Parameter | Type |
12+
| ------ | ------ |
13+
| `__namedParameters` | `ClassAttributes`\<`HTMLDivElement`\> & `HTMLAttributes`\<`HTMLDivElement`\> & `VariantProps`\<(`props?`) => `string`\> |
14+
15+
## Returns
16+
17+
`Element`

‎docs/docs/api/app-kit-ui/functions/AlertDescription.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Function: AlertDescription()
2+
3+
```ts
4+
function AlertDescription(__namedParameters): Element;
5+
```
6+
7+
Defined in: [packages/app-kit-ui/src/react/ui/alert.tsx:50](https://github.com/databricks/app-kit/blob/main/packages/app-kit-ui/src/react/ui/alert.tsx#L50)
8+
9+
## Parameters
10+
11+
| Parameter | Type |
12+
| ------ | ------ |
13+
| `__namedParameters` | `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>\> |
14+
15+
## Returns
16+
17+
`Element`

‎docs/docs/api/app-kit-ui/functions/AlertDialog.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Function: AlertDialog()
2+
3+
```ts
4+
function AlertDialog(__namedParameters): Element;
5+
```
6+
7+
Defined in: [packages/app-kit-ui/src/react/ui/alert-dialog.tsx:7](https://github.com/databricks/app-kit/blob/main/packages/app-kit-ui/src/react/ui/alert-dialog.tsx#L7)
8+
9+
## Parameters
10+
11+
| Parameter | Type |
12+
| ------ | ------ |
13+
| `__namedParameters` | `AlertDialogProps` |
14+
15+
## Returns
16+
17+
`Element`

‎docs/docs/api/app-kit-ui/functions/AlertDialogAction.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Function: AlertDialogAction()
2+
3+
```ts
4+
function AlertDialogAction(__namedParameters): Element;
5+
```
6+
7+
Defined in: [packages/app-kit-ui/src/react/ui/alert-dialog.tsx:119](https://github.com/databricks/app-kit/blob/main/packages/app-kit-ui/src/react/ui/alert-dialog.tsx#L119)
8+
9+
## Parameters
10+
11+
| Parameter | Type |
12+
| ------ | ------ |
13+
| `__namedParameters` | `AlertDialogActionProps` & `RefAttributes`\<`HTMLButtonElement`\> |
14+
15+
## Returns
16+
17+
`Element`

0 commit comments

Comments
 (0)