Skip to content

Commit 4b34c4a

Browse files
authored
docs: better docs (#41)
* chore: themes * docs: first docs iteration * docs: better docs * fix: type errors and format * docs: community pages * chore: redirect home page to intro for now * fix: format * docs: color system page * docs: more docs pages * fix: format * chore: remove git hooks * chore: update themes page * docs: update intro
1 parent d95c348 commit 4b34c4a

Some content is hidden

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

62 files changed

+2314
-1009
lines changed

.husky/pre-commit

-63
This file was deleted.

.husky/prepare-commit-msg

-63
This file was deleted.

lefthook.yml

-9
This file was deleted.

package.json

-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@
4848
"eslint-config-next": "^14.0.4",
4949
"eslint-config-prettier": "^9.1.0",
5050
"eslint-config-turbo": "^2.1.3",
51-
"lefthook": "^1.7.18",
5251
"prettier": "^3.3.3",
5352
"prettier-plugin-tailwindcss": "^0.6.8",
5453
"turbo": "^2.0.12"

pnpm-lock.yaml

+5-105
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

www/content/docs/components/buttons/button.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,13 @@ To add additional context for a button label, such as a search icon next to the
104104
<Button suffix={<UplaodIcon />}>Upload</Button>`}
105105
/>
106106

107-
### Loading
107+
### Pending
108108

109-
Use the `isLoading` prop to control the loading state of the button, if you need to wait for a button's action to be completed.
109+
Use the `isPending` prop to control the loading state of the button, if you need to wait for a button's action to be completed.
110110

111111
<ComponentPreview
112112
name="core/button-loading"
113-
preview={`<Button isLoading>Button</Button>`}
113+
preview={`<Button isPending>Button</Button>`}
114114
/>
115115

116116
### Disabled

www/content/docs/components/feedback/progress.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Use `Progress` to show the completion progress of a task. It can represent eithe
5454
### Best pratices
5555

5656
When possible, use a determinate progress indicator.<br/>
57-
An indeterminate progress indicator shows that a process is occurring, but it doesnt help people estimate how long a task will take.<br/>
57+
An indeterminate progress indicator shows that a process is occurring, but it doesn't help people estimate how long a task will take.<br/>
5858
A determinate progress indicator can help people decide whether to do something else while waiting for the task to complete, restart the task at a different time, or abandon the task.
5959

6060
## Options
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"pages": ["aspect-ratio", "scroll-area"]
2+
"pages": ["aspect-ratio", "scroll-area", "table"]
33
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Table
3+
description: Displays content within a desired ratio.
4+
thumbnail:
5+
image: /previews/components/core/aspect-ratio.jpeg
6+
links:
7+
- label: Radix docs
8+
href: https://www.radix-ui.com/primitives/docs/components/aspect-ratio
9+
- label: Report an issue
10+
href: https://github.com/mehdibha/dotUI/issues/new/choose
11+
- label: Edit this page
12+
href: https://github.com/mehdibha/dotUI/tree/main/content/components/layout/aspect-ratio.mdx?plain=1
13+
---
14+
15+
SALEM TAREK

www/content/docs/components/overlay/tooltip.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ The offset is the distance between the end of the tip and the target.
107107

108108
### Container padding
109109

110-
To make sure that the tooltip will stay within certain boundaries (e.g., a browser window) its possible to define a container and a container padding value to respect. The default value for this is 12 px.
110+
To make sure that the tooltip will stay within certain boundaries (e.g., a browser window) it's possible to define a container and a container padding value to respect. The default value for this is 12 px.
111111

112112
<ComponentPreview
113113
name="core/tooltip-container-padding"

0 commit comments

Comments
 (0)