Skip to content

Commit f0fd97b

Browse files
committed
chore: improve introduction and guidance for TEDI React components #534
1 parent 26ca01b commit f0fd97b

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

src/tedi/docs/_welcome.mdx

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,32 @@ import { Meta, Title, Subtitle, Unstyled } from '@storybook/blocks';
77
Here you can find our design guidelines, component documentation, and resources for building apps with
88
`@tedi-design-system/react`
99

10-
## Resources
10+
## Component Types
11+
12+
TEDI offers two types of components:
13+
14+
### TEDI-Ready Components
15+
16+
These components are fully **supervised and maintained by the TEDI team**.
17+
18+
- Updates and contributions are reviewed by the TEDI team before merging into the `rc` branch.
19+
- They require unit tests.
20+
- They follow strict design and accessibility guidelines.
21+
- The TEDI team ensures stability and fixes issues in these components.
22+
23+
### Community Components
24+
25+
These are **community-driven components**, and the **community is responsible for maintaining them**.
26+
27+
- Contributors own their components: they are responsible for bug fixes, updates, and stability.
28+
- Unit tests are optional but recommended.
29+
- Anyone can contribute directly without TEDI-team approval.
30+
- Community contributions can still improve TEDI-Ready components, but changes must go through TEDI-team review.
31+
- If a community component depends on a TEDI-Ready component and issues arise due to the TEDI-Ready component, the TEDI team will handle it—but **if the issue is within the community component itself, the responsibility lies with the contributor/community**.
32+
33+
---
34+
35+
#### **Resources:**
1136

1237
- [Repository](https://github.com/TEDI-Design-System/react)
1338
- [WIKI](https://github.com/TEDI-Design-System/general)

0 commit comments

Comments
 (0)