Skip to content

Commit a5a6039

Browse files
committed
docs: update readme and link checker
1 parent d8f3b6d commit a5a6039

File tree

4 files changed

+23
-21
lines changed

4 files changed

+23
-21
lines changed

.github/workflows/link-checker.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
id: lychee
2424
uses: lycheeverse/[email protected]
2525
with:
26-
args: --config ./lychee.toml --verbose --no-progress README.md
26+
args: --config ./lychee.toml --verbose --no-progress .
2727
fail: true
2828

2929
- name: Create Issue From File

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,11 @@
22

33
UX Patterns for Developers is a free collection of UX patterns towards developers who want to understand how to build effective UI components accessible and usable.
44

5+
![Screenshot of the homepage ofUX Patterns for Devs](./public/img/ux-patterns-developers.webp)
6+
57
> [!NOTE]
68
> This project is a work in progress. New content and updates should be expected regularly.
79
8-
## Getting Started
9-
10-
To start the project locally, run:
11-
12-
```bash
13-
pnpm run dev
14-
```
15-
16-
### Generate new pattern
17-
18-
This command will generate a new pattern template. Simply specify the language, the category and the name of the pattern starting with a capital letter.
19-
20-
```bash
21-
pnpm run generate
22-
```
23-
2410
## 🧩 Patterns
2511

2612
This is an non-exhaustive list of available and incoming patterns.
@@ -69,6 +55,22 @@ This is an non-exhaustive list of available and incoming patterns.
6955
- Notifications (coming soon)
7056
- Progress Indicator (coming soon)
7157

58+
## Getting Started
59+
60+
To start the project locally, run:
61+
62+
```bash
63+
pnpm run dev
64+
```
65+
66+
### Generate new pattern
67+
68+
This command will generate a new pattern template. Simply specify the language, the category and the name of the pattern starting with a capital letter.
69+
70+
```bash
71+
pnpm run generate
72+
```
73+
7274
## ✨ Contributors
7375

7476
You are welcome to contribute to this project! Please read the [CONTRIBUTING.md](https://github.com/thedaviddias/ux-patterns-for-developers/blob/main/.github/CONTRIBUTING.md).

content/en/docs/forms/autocomplete.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,6 @@ They combine the flexibility of text input with dropdown-style selection, provid
4545

4646
## Anatomy
4747

48-
```mermaid
49-
50-
```
51-
5248
### Component Structure
5349

5450
1. **Container**
@@ -151,6 +147,10 @@ These design tokens follow the [Design Tokens Format](https://design-tokens.gith
151147
- [9 UX Best Practice Design Patterns for Autocomplete Suggestions](https://baymard.com/blog/autocomplete-design) by Baymard Institute
152148
- [Best Practices: Designing autosuggest experiences](https://uxmag.com/articles/best-practices-designing-autosuggest-experiences)
153149

150+
## Documentation
151+
152+
- [WAI-ARIA: Combobox Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/combobox/)
153+
154154
### Libraries
155155

156156
- [Library 1]
41.6 KB
Binary file not shown.

0 commit comments

Comments
 (0)