Skip to content
This repository was archived by the owner on Mar 7, 2026. It is now read-only.

Commit c0ba6f1

Browse files
committed
fix: add exclusions for inapplicable governance structure rules
- exclude CON-GOV-001/008/013/014/017 (wrong archetype for ui library monorepo) - add overview, architecture, related repos sections to README
1 parent 6c7184a commit c0ba6f1

File tree

2 files changed

+26
-7
lines changed

2 files changed

+26
-7
lines changed

.compliance/config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ ignore_paths:
2424

2525
exclude:
2626
- CON-PFM-010 # redundant with CON-GOV-005 allowlist
27+
- CON-GOV-001 # node-ts single app structure — ui-kit is a monorepo
28+
- CON-GOV-008 # platform-sdk monorepo structure — not applicable
29+
- CON-GOV-013 # architecture repo structure — only saas-architecture
30+
- CON-GOV-014 # app monorepo structure — ui-kit is a library monorepo
31+
- CON-GOV-017 # uses node-ts-app structure template — wrong archetype
2732

2833
suppress:
2934
- entity: CON-DVO-002

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22

33
[![Compliance](.compliance/badge.svg)](.compliance/report.md)
44

5-
React component library and showcase admin app built with modern tools:
5+
## Overview
66

7-
- 🎨 Shadcn UI + DaisyUI + Tailwind
8-
- 📊 TanStack Table
9-
- 🔄 Zustand + TanStack Query + React Hook Form
10-
- 🏗️ Vite + TypeScript + pnpm
11-
- 📚 Storybook + Vitest + Playwright
7+
Bare-metal React component library (`@etherisc/ui-kit`) providing 60+ UI primitives for the Etherisc SaaS platform. Built on Radix UI and Tailwind CSS v4, it serves as Layer 1 in the three-layer frontend architecture (ADR-0016). Domain apps consume it indirectly via `@etherisc-saas/design`.
8+
9+
Key technologies: Radix UI, Tailwind CSS v4, TanStack Table, React Hook Form + Zod, Storybook, Vitest, Playwright.
1210

1311
## Installation
1412

@@ -65,7 +63,7 @@ function App() {
6563

6664
For complete documentation and examples, visit our [Storybook](https://etherisc.github.io/ui-kit/).
6765

68-
## Development Setup
66+
## Development
6967

7068
### For Contributors (Developing the UI Kit)
7169

@@ -141,3 +139,19 @@ For bug reports and feature requests, please use our [GitHub Issues](https://git
141139
### Code of Conduct
142140

143141
This project follows a [Code of Conduct](CONTRIBUTING.md#code-of-conduct) to ensure a welcoming environment for all contributors.
142+
143+
## Architecture
144+
145+
The ui-kit is a pnpm monorepo with three packages:
146+
147+
- `packages/ui-kit` — the published component library (`@etherisc/ui-kit`)
148+
- `packages/showcase` — demo/admin application for visual testing
149+
- `packages/eslint-plugin-ui-kit-rules` — custom ESLint rules for component quality
150+
151+
In the platform's three-layer architecture, ui-kit is Layer 1 (bare-metal atoms). It is consumed exclusively by `@etherisc-saas/design` (Layer 2, in `platform-sdk/packages/design`). Domain apps (Layer 3) never import from ui-kit directly.
152+
153+
## Related Repos
154+
155+
- [`platform-sdk`](https://github.com/etherisc-saas/platform-sdk) — contains `@etherisc-saas/design` which wraps ui-kit
156+
- [`platform-app`](https://github.com/etherisc-saas/platform-app) — primary domain app consuming the design package
157+
- [`saas-architecture`](https://github.com/etherisc-saas/saas-architecture) — architectural governance and compliance rules

0 commit comments

Comments
 (0)