Skip to content

Commit 2de7330

Browse files
fix: resolve markdown linting issues in frontend contributing guide
Fixed 11 markdown linting errors found by markdownlint-cli2: - MD022: Added blank lines around headings - MD032: Added blank lines around lists (9 instances) - MD031: Added blank lines around fenced code blocks - MD040: Added language specification to fenced code block All markdown linting rules now pass with 0 errors. Co-authored-by: BrunoQuaresma <3165839+BrunoQuaresma@users.noreply.github.com>
1 parent 1dc4f85 commit 2de7330

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/about/contributing/frontend.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ the most important.
8787
**⚠️ Important: We are currently migrating from Material UI (MUI) to shadcn/ui and from Emotion to TailwindCSS.**
8888

8989
### Current State
90+
9091
- **~210 files** still use MUI components (`@mui/material`)
9192
- **~41 components** have been migrated to use TailwindCSS classes
9293
- **shadcn/ui components** are being added incrementally to `src/components/`
@@ -95,13 +96,15 @@ the most important.
9596
### Migration Guidelines
9697

9798
When working on existing components:
99+
98100
1. **Prefer shadcn/ui components** over MUI when available
99101
2. **Use TailwindCSS classes** instead of Emotion `css` prop or `sx` prop
100102
3. **Check `src/components/`** for existing shadcn/ui implementations before creating new ones
101103
4. **Do not use the shadcn CLI** - manually add components to maintain consistency
102104
5. **Update tests** to reflect new component structure when migrating
103105

104106
For new components:
107+
105108
1. **Always use TailwindCSS** for styling
106109
2. **Use shadcn/ui components** as the foundation
107110
3. **Use Lucide React icons** instead of MUI icons
@@ -110,6 +113,7 @@ For new components:
110113
### Semantic Color System
111114

112115
Use the custom semantic color tokens defined in our Tailwind configuration:
116+
113117
- **Content colors**: `content-primary`, `content-secondary`, `content-disabled`, `content-invert`, `content-success`, `content-link`, `content-destructive`, `content-warning`
114118
- **Surface colors**: `surface-primary`, `surface-secondary`, `surface-tertiary`, `surface-quaternary`, `surface-invert-primary`, `surface-invert-secondary`, `surface-destructive`, `surface-green`, `surface-grey`, `surface-orange`, `surface-sky`, `surface-red`, `surface-purple`
115119
- **Border colors**: `border-default`, `border-warning`, `border-destructive`, `border-success`, `border-hover`
@@ -259,12 +263,14 @@ business logic specific to the product.
259263
#### shadcn/ui Components (Preferred)
260264

261265
We use [shadcn/ui](https://ui.shadcn.com/) components built on top of [Radix UI](https://www.radix-ui.com/) primitives. These components are:
266+
262267
- **Accessible by default** with ARIA attributes and keyboard navigation
263268
- **Customizable** with TailwindCSS classes
264269
- **Consistent** with our design system
265270
- **Type-safe** with full TypeScript support
266271

267272
Existing shadcn/ui components can be found in `src/components/`. Examples include:
273+
268274
- `Checkbox` - Form checkbox input
269275
- `ScrollArea` - Custom scrollable area
270276
- `Table` - Data table with sorting and filtering
@@ -276,6 +282,7 @@ Existing shadcn/ui components can be found in `src/components/`. Examples includ
276282
#### MUI Components (Legacy)
277283

278284
The codebase still contains MUI v5 components that are being phased out. When encountering MUI components:
285+
279286
1. **Check if a shadcn/ui equivalent exists** in `src/components/`
280287
2. **Migrate to the shadcn/ui version** when making changes
281288
3. **Create a new shadcn/ui component** if no equivalent exists
@@ -297,6 +304,7 @@ We strive to keep our UI accessible. **shadcn/ui components are accessible by de
297304
#### Color Contrast
298305

299306
Colors should come from our semantic color tokens in the Tailwind theme. These tokens are designed to meet WCAG level AA compliance (4.5:1 contrast ratio). If you need to add a custom color, ensure proper contrast using:
307+
300308
- [WebAIM Contrast Checker](https://webaim.org/resources/contrastchecker/)
301309
- [Dequeue's axe DevTools](https://chrome.google.com/webstore/detail/axe-devtools-web-accessib/lhdoppojpmngadmnindnejefpokejbdd)
302310

@@ -663,7 +671,8 @@ When a shadcn/ui equivalent doesn't exist:
663671
7. **Include accessibility features** (ARIA attributes, keyboard support)
664672

665673
Example component structure:
666-
```
674+
675+
```text
667676
src/components/NewComponent/
668677
├── NewComponent.tsx
669678
├── NewComponent.stories.tsx

0 commit comments

Comments
 (0)