@felan-ai/design-system 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -10
- package/package.json +1 -5
- package/project/README.md +1 -3
- package/project/SKILL.md +0 -33
- package/project/design.md +0 -118
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
The design system for **Felan** — an agentic engineering platform. It captures the visual language, tone, and component vocabulary for Felan's marketing site (`felan.ai`) and product dashboard (`app.felan.ai`): canonical tokens and HTML/CSS component previews, plus a printable single-page catalog.
|
|
6
6
|
|
|
7
|
-
The full design spec — palette, typography, spacing, component anatomy, voice and copy rules — lives in [`project/README.md`](project/README.md). Agents
|
|
7
|
+
The full design spec — palette, typography, spacing, component anatomy, voice and copy rules — lives in [`project/README.md`](project/README.md). Agents use the GitHub-installed [`felan-design`](skills/felan-design/SKILL.md) skill and its portable [`design.md`](skills/felan-design/design.md) guidance.
|
|
8
8
|
|
|
9
9
|
## Repository layout
|
|
10
10
|
|
|
@@ -12,17 +12,27 @@ The full design spec — palette, typography, spacing, component anatomy, voice
|
|
|
12
12
|
├── catalog.html ← single-page catalog: readme + every preview, print-ready
|
|
13
13
|
├── project/ ← the design system itself
|
|
14
14
|
│ ├── README.md ← full design spec (start here)
|
|
15
|
-
│ ├── design.md ← portable agent design guidance
|
|
16
|
-
│ ├── SKILL.md ← skill contract for Claude Code / agents
|
|
17
15
|
│ ├── tokens.css ← canonical tokens + semantic type classes
|
|
18
16
|
│ ├── colors_and_type.css ← preview entry with hosted Geist fonts
|
|
19
17
|
│ ├── styles.css ← font-free production entry
|
|
20
18
|
│ ├── assets/ ← logos, icons, customer & integration marks
|
|
21
19
|
│ ├── templates/ ← reusable customer-facing artifacts, including commercial quotes
|
|
22
20
|
│ └── preview/ ← design-system cards (brand, colors, type, components…)
|
|
21
|
+
├── skills/felan-design/ ← GitHub-installed agent skill + design.md
|
|
23
22
|
└── scripts/repo-browser/ ← local HTTP server for the catalog
|
|
24
23
|
```
|
|
25
24
|
|
|
25
|
+
## Agent skill
|
|
26
|
+
|
|
27
|
+
Install the two-file `felan-design` skill directly from GitHub:
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
npx skills add felan-ai/design-system --skill felan-design
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
The skill bundles only `SKILL.md` and `design.md`. Tokens, assets, templates,
|
|
34
|
+
and lint rules remain in the npm package.
|
|
35
|
+
|
|
26
36
|
## Browse the catalog
|
|
27
37
|
|
|
28
38
|
The catalog fetches the readme, manifest, and previews at load time, so it must be served over HTTP (opening `catalog.html` from `file://` won't work):
|
|
@@ -35,14 +45,14 @@ scripts/repo-browser/stop.sh
|
|
|
35
45
|
|
|
36
46
|
Or run it in the foreground with `scripts/repo-browser/serve.sh`. By default the OS assigns a free local port, so parallel repo browsers do not overlap. Pass a preferred starting port if needed: `scripts/repo-browser/start.sh <port>`. Requires Node ≥ 18, no dependencies.
|
|
37
47
|
|
|
38
|
-
The catalog
|
|
48
|
+
The catalog renders the project readme first, then every preview grouped by section (Brand, Colors, Components, Spacing, Type).
|
|
39
49
|
|
|
40
50
|
## npm package
|
|
41
51
|
|
|
42
52
|
This repository publishes `@felan-ai/design-system`, which contains the
|
|
43
53
|
canonical CSS, tokens, Felan-owned assets, reusable quote template, design
|
|
44
|
-
specification,
|
|
45
|
-
|
|
54
|
+
specification, and shared `@shadcn/lint` policy. The agent skill is installed
|
|
55
|
+
separately from GitHub and is not part of the npm package.
|
|
46
56
|
|
|
47
57
|
```sh
|
|
48
58
|
pnpm add @felan-ai/design-system
|
|
@@ -57,8 +67,7 @@ The package's HSL-triplet tokens are consumed with `hsl(var(--token))`.
|
|
|
57
67
|
self-host Geist. Static previews use `colors_and_type.css`, which also loads
|
|
58
68
|
Geist from Google Fonts. Public exports are documented in the package README
|
|
59
69
|
and include `./styles.css`, `./tokens.css`, `./colors_and_type.css`, `./spec`,
|
|
60
|
-
`./
|
|
61
|
-
`./eslint/shadcn`.
|
|
70
|
+
`./assets/*`, `./templates/quote.html`, and `./eslint/shadcn`.
|
|
62
71
|
|
|
63
72
|
See [`docs/consuming.md`](docs/consuming.md) for the complete export table,
|
|
64
73
|
package exclusions, lint limitations, asset policy, and consumer rollout.
|
|
@@ -80,6 +89,6 @@ Tailwind 4 migration. `go-to-market` consumes the assets and templates only.
|
|
|
80
89
|
- The design medium is HTML/CSS/JS **prototypes** — reference implementations to match visually, not production code to copy structurally.
|
|
81
90
|
- The reusable commercial quote template lives in `project/templates/quote/`; see its README for
|
|
82
91
|
placeholders and print instructions.
|
|
83
|
-
-
|
|
92
|
+
- The repo browser derives catalog metadata from each preview's `@dsCard` comment, so previews stay in sync without generated files.
|
|
84
93
|
- Static previews load Geist Sans/Mono from the Google Fonts CDN; production consumers provide their own font files.
|
|
85
|
-
- `npm pack --dry-run` and the package verifier are the source of truth for the published file surface; catalog previews
|
|
94
|
+
- `npm pack --dry-run` and the package verifier are the source of truth for the published file surface; catalog previews are repository-only.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@felan-ai/design-system",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "Felan design tokens, brand guidance, reusable assets, templates, and lint policy",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -24,8 +24,6 @@
|
|
|
24
24
|
"project/tokens.css",
|
|
25
25
|
"project/colors_and_type.css",
|
|
26
26
|
"project/README.md",
|
|
27
|
-
"project/design.md",
|
|
28
|
-
"project/SKILL.md",
|
|
29
27
|
"lint",
|
|
30
28
|
"project/assets/felan-logo.svg",
|
|
31
29
|
"project/assets/felan-logo.png",
|
|
@@ -45,8 +43,6 @@
|
|
|
45
43
|
"./tokens.css": "./project/tokens.css",
|
|
46
44
|
"./colors_and_type.css": "./project/colors_and_type.css",
|
|
47
45
|
"./spec": "./project/README.md",
|
|
48
|
-
"./design": "./project/design.md",
|
|
49
|
-
"./skill": "./project/SKILL.md",
|
|
50
46
|
"./lint-policy": "./lint/shadcn-policy.json",
|
|
51
47
|
"./eslint/shadcn": "./lint/eslint-shadcn.mjs",
|
|
52
48
|
"./assets/felan-logo.svg": "./project/assets/felan-logo.svg",
|
package/project/README.md
CHANGED
|
@@ -28,7 +28,7 @@ Felan ships two primary surfaces, both represented in this system:
|
|
|
28
28
|
|
|
29
29
|
## Content fundamentals
|
|
30
30
|
|
|
31
|
-
**What Felan is:** an agentic engineering platform — the team layer for AI-native software development. Engineers got faster with
|
|
31
|
+
**What Felan is:** an agentic engineering platform — the team layer for AI-native software development. Engineers got faster with coding copilots and agents; the team layer around that work — shared context, standards, coordination, autonomy boundaries — did not keep up. Felan gives engineering orgs cloud background agents that work in existing tools, share team knowledge, follow guardrails, and improve from feedback.
|
|
32
32
|
|
|
33
33
|
**The anchor line:** *Copilots make engineers faster. Felan makes the engineering team faster.*
|
|
34
34
|
|
|
@@ -236,8 +236,6 @@ These are all copied into `assets/integrations/` and `assets/customers/` here.
|
|
|
236
236
|
|
|
237
237
|
```
|
|
238
238
|
├── README.md ← you are here
|
|
239
|
-
├── design.md ← portable guidance for agents building Felan interfaces
|
|
240
|
-
├── SKILL.md ← skill contract for Claude Code / agents
|
|
241
239
|
├── tokens.css ← canonical tokens + semantic type classes
|
|
242
240
|
├── colors_and_type.css ← preview entry with hosted Geist fonts
|
|
243
241
|
├── styles.css ← font-free production entry
|
package/project/SKILL.md
DELETED
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: felan-design
|
|
3
|
-
description: Use whenever creating, changing, or reviewing a Felan interface, page, visual artifact, or customer-facing brand copy. Covers production UI, marketing pages, prototypes, documents, and presentations.
|
|
4
|
-
user-invocable: true
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Felan Design
|
|
8
|
-
|
|
9
|
-
Before doing visual or brand-copy work, read `design.md` next to this file. It is the portable agent guidance bundled with this skill. Packaged consumers expose the same file as `@felan-ai/design-system/design`.
|
|
10
|
-
|
|
11
|
-
Read `README.md` when the task needs the full component, asset, iconography, or content reference. Read `tokens.css` for exact token values. Inspect the consuming application's existing components before proposing new ones.
|
|
12
|
-
|
|
13
|
-
## Workflow
|
|
14
|
-
|
|
15
|
-
1. Identify the reader, task, surface, primary action, evidence, and required states.
|
|
16
|
-
2. Inspect the repository's framework, routes, components, tokens, and conventions.
|
|
17
|
-
3. Choose the marketing, product, or artifact guidance in `design.md`.
|
|
18
|
-
4. Reuse existing components and assets; add only what the task cannot express already.
|
|
19
|
-
5. Implement responsive and accessible behavior without introducing a parallel design system.
|
|
20
|
-
6. Run the repository's required checks and review the result against the pre-ship checklist in `design.md`.
|
|
21
|
-
|
|
22
|
-
If essential product, audience, content, or delivery details are missing, ask focused questions before designing. If the user invokes this skill without a specific deliverable, ask what they want to build and whether it is production UI or a visual artifact.
|
|
23
|
-
|
|
24
|
-
For static slides, mocks, or prototypes, copy the required packaged assets and produce a viewable artifact. For production work, preserve the application's architecture and use its installed design-system package and components.
|
|
25
|
-
|
|
26
|
-
## Included References
|
|
27
|
-
|
|
28
|
-
- `design.md` — required portable guidance for agent decisions and verification
|
|
29
|
-
- `README.md` — voice, tone, visual foundations, iconography, content fundamentals
|
|
30
|
-
- `tokens.css` — canonical HSL tokens (light + dark) and semantic typography classes
|
|
31
|
-
- `colors_and_type.css` — preview entry that adds hosted Geist fonts
|
|
32
|
-
- `assets/` — packaged Felan marks, app icons, and integration SVGs
|
|
33
|
-
- `preview/` — repository-only design cards for colors, type, spacing, components, and brand
|
package/project/design.md
DELETED
|
@@ -1,118 +0,0 @@
|
|
|
1
|
-
# Felan Design Guidance
|
|
2
|
-
|
|
3
|
-
Use this guide whenever designing or implementing a Felan interface, page, prototype, document, or presentation.
|
|
4
|
-
|
|
5
|
-
Felan is an agentic engineering platform — the team layer for AI-native software development. Felan is also the lead agent. Bugzy is one QA agent under Felan, never the platform.
|
|
6
|
-
|
|
7
|
-
Anchor line: **Copilots make engineers faster. Felan makes the engineering team faster.** Qualify the audience by AI adoption, not company size.
|
|
8
|
-
|
|
9
|
-
This is the portable agent guide. `README.md` contains the full reference, while `tokens.css` is authoritative for token values.
|
|
10
|
-
|
|
11
|
-
## Start With the Reader and Task
|
|
12
|
-
|
|
13
|
-
Before choosing a layout, identify:
|
|
14
|
-
|
|
15
|
-
1. Who is using or reading this?
|
|
16
|
-
2. What must they understand, decide, approve, configure, or complete?
|
|
17
|
-
3. What is the single most important next action?
|
|
18
|
-
4. What evidence and states are needed to support that task?
|
|
19
|
-
|
|
20
|
-
Shape the hierarchy around those answers. Do not start from a generic dashboard, landing-page template, or card grid. Do not invent features, proof, data, or infrastructure to make a design look complete.
|
|
21
|
-
|
|
22
|
-
## Choose the Correct Surface
|
|
23
|
-
|
|
24
|
-
### Marketing
|
|
25
|
-
|
|
26
|
-
- Force dark mode.
|
|
27
|
-
- Lead with team-level delivery, not AI novelty or governance.
|
|
28
|
-
- Use soft green and blue radial orbs in the hero and final CTA; keep interior sections restrained.
|
|
29
|
-
- Use one green CTA per screen. Render other actions as neutral, outline, ghost, or text links.
|
|
30
|
-
- Show sessions, approvals, delegation, and work inside existing tools. Do not use stock photography, illustrated people, 3D renders, or fake product screenshots.
|
|
31
|
-
- Add customer proof, prices, metrics, and logos only when approved content and assets exist.
|
|
32
|
-
|
|
33
|
-
### Product
|
|
34
|
-
|
|
35
|
-
- Default to light mode and support dark mode.
|
|
36
|
-
- Favor clear hierarchy, readable information density, and predictable interactions.
|
|
37
|
-
- Reuse the established application shell, navigation, components, and state patterns.
|
|
38
|
-
- Make status, ownership, next actions, approvals, and audit information easy to scan.
|
|
39
|
-
- Reserve green for the primary action, active or focus state, and positive semantic state. Do not make every control green.
|
|
40
|
-
|
|
41
|
-
### Prototypes, Documents, and Presentations
|
|
42
|
-
|
|
43
|
-
- Use the same tokens, typography, assets, voice, and claim rules.
|
|
44
|
-
- Structure the artifact around its reader rather than imitating the marketing site or product shell.
|
|
45
|
-
- Use an existing template when one fits. Do not create a parallel artifact framework for a one-off deliverable.
|
|
46
|
-
|
|
47
|
-
## Use the Existing System
|
|
48
|
-
|
|
49
|
-
Inspect the consuming codebase before creating anything.
|
|
50
|
-
|
|
51
|
-
- Reuse existing components and variants before adding new ones.
|
|
52
|
-
- Preserve the host framework, routes, layout conventions, and interaction patterns.
|
|
53
|
-
- Import `styles.css` for the font-free production foundation and use `hsl(var(--token))` values from `tokens.css`.
|
|
54
|
-
- Use the consuming application's Geist installation. Hosted fonts in `colors_and_type.css` are for static previews.
|
|
55
|
-
- Treat `preview/` as visual reference, not production structure to copy.
|
|
56
|
-
- Add a component, variant, or token only when the required task cannot be expressed by the current system.
|
|
57
|
-
|
|
58
|
-
Do not introduce raw brand colors, a parallel token layer, a second component system, or a speculative abstraction.
|
|
59
|
-
|
|
60
|
-
## Visual Language
|
|
61
|
-
|
|
62
|
-
- Brand green is `hsl(152 44% 26%)` in light mode and `hsl(152 46% 34%)` in dark mode. It is the only brand accent.
|
|
63
|
-
- Use the canonical warm-neutral and semantic tokens. Status and chart colors communicate meaning; they are not competing accents.
|
|
64
|
-
- Use surface luminance steps for elevation. Keep shadows rare and subtle.
|
|
65
|
-
- Use 6px buttons, 12px cards and surfaces, and full pills.
|
|
66
|
-
- Use Geist Sans for interface and editorial text. Use Geist Mono for code, file names, identifiers, and timestamps.
|
|
67
|
-
- Use Title Case for headlines and sentence case for subheads, labels, buttons, and navigation.
|
|
68
|
-
- Keep display text tightly tracked. Hero headlines use 800 weight; section headings use 700.
|
|
69
|
-
- Use Lucide outline icons with a 2px stroke: 16px inline, 20px in card headers, and 40px in icon tiles.
|
|
70
|
-
- Use the existing geometric aperture mark. Do not redraw it or create a wordmark variant. The lockup is **Felan AI**; body copy says **Felan**.
|
|
71
|
-
- On dark backgrounds, place the green mark on its established cream protection tile.
|
|
72
|
-
- Center page content in a container up to 1400px with consistent `px-4 md:px-6` gutters. Use one column on mobile and add columns only when the content supports them.
|
|
73
|
-
|
|
74
|
-
## Voice and Claims
|
|
75
|
-
|
|
76
|
-
Write with calm authority: confident, technical, and pragmatic.
|
|
77
|
-
|
|
78
|
-
- Explain what changes for the team instead of announcing that something uses AI.
|
|
79
|
-
- Address benefits with second-person **you**. Refer to **Felan** in the third person.
|
|
80
|
-
- Use short declarative headings, concise explanations, and em dashes where natural.
|
|
81
|
-
- Do not use exclamation marks or emoji in UI chrome.
|
|
82
|
-
- Name agents by SDLC role: Developer agent, QA agent, SRE agent, or General Purpose agent. Do not create mascots.
|
|
83
|
-
- Use terms such as background agent, session, delegation, automation, trigger, guardrails, approvals, audit log, team memory, SDLC, repo, PR, and rollout.
|
|
84
|
-
- Keep QA-era terms such as coverage gap, regression, triage, flaky, and pass rate inside explicit QA examples only.
|
|
85
|
-
- Avoid hype such as revolutionary, seamless, cutting-edge, supercharge, unlock, game-changer, magical, solution, ecosystem, synergy, empowers, transforms, 10x, AI-powered, AI-driven, and AI-first.
|
|
86
|
-
- Do not position Felan as an orchestrator of third-party agents or as a replacement for engineers. Humans own direction, judgment, and approvals.
|
|
87
|
-
|
|
88
|
-
Only make claims supported by the brief, including:
|
|
89
|
-
|
|
90
|
-
- `Start with one repo`
|
|
91
|
-
- `Works in Slack, GitHub, Linear, Jira`
|
|
92
|
-
- `Every agent action logged`
|
|
93
|
-
|
|
94
|
-
Never invent customer quotes, metrics, outcomes, prices, compliance claims, or setup times. Do not reuse Bugzy-era claims such as `5-minute setup`, `No config required`, `SOC2 ready`, `EUR 250/month`, ratios, or `auto-healed`.
|
|
95
|
-
|
|
96
|
-
The legal line is `© 2026 Felan`.
|
|
97
|
-
|
|
98
|
-
## Interaction, Responsive Behavior, and Accessibility
|
|
99
|
-
|
|
100
|
-
- Design mobile-first and verify narrow and wide layouts.
|
|
101
|
-
- Preserve reading order when columns collapse or feature blocks reverse.
|
|
102
|
-
- Prevent horizontal overflow, clipped headings, and controls that depend on hover.
|
|
103
|
-
- Provide visible keyboard focus and accessible names for icon-only controls.
|
|
104
|
-
- Use semantic HTML and native controls before custom interaction patterns.
|
|
105
|
-
- Do not communicate status through color alone.
|
|
106
|
-
- Keep motion restrained and functional. Avoid bounce and respect `prefers-reduced-motion`.
|
|
107
|
-
- Cover relevant loading, empty, error, disabled, success, permission, and long-content states.
|
|
108
|
-
|
|
109
|
-
## Pre-Ship Check
|
|
110
|
-
|
|
111
|
-
- The reader, task, surface, and primary action are clear.
|
|
112
|
-
- Existing components and canonical tokens are reused.
|
|
113
|
-
- Marketing is dark; product defaults light and supports dark.
|
|
114
|
-
- There is no more than one green CTA per screen.
|
|
115
|
-
- Colors, type, radii, icons, logo treatment, and copy follow Felan rules.
|
|
116
|
-
- No QA-era framing, invented proof, fake screenshot, or unavailable asset remains.
|
|
117
|
-
- Responsive layouts, keyboard focus, contrast, content states, and reduced motion were checked.
|
|
118
|
-
- No unnecessary component, token, framework, or abstraction was introduced.
|