@felan-ai/design-system 0.1.1 → 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 -7
- package/package.json +1 -3
- package/project/README.md +1 -2
- package/project/SKILL.md +0 -37
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).
|
|
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,16 +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
|
-
│ ├── SKILL.md ← skill contract for Claude Code / agents
|
|
16
15
|
│ ├── tokens.css ← canonical tokens + semantic type classes
|
|
17
16
|
│ ├── colors_and_type.css ← preview entry with hosted Geist fonts
|
|
18
17
|
│ ├── styles.css ← font-free production entry
|
|
19
18
|
│ ├── assets/ ← logos, icons, customer & integration marks
|
|
20
19
|
│ ├── templates/ ← reusable customer-facing artifacts, including commercial quotes
|
|
21
20
|
│ └── preview/ ← design-system cards (brand, colors, type, components…)
|
|
21
|
+
├── skills/felan-design/ ← GitHub-installed agent skill + design.md
|
|
22
22
|
└── scripts/repo-browser/ ← local HTTP server for the catalog
|
|
23
23
|
```
|
|
24
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
|
+
|
|
25
36
|
## Browse the catalog
|
|
26
37
|
|
|
27
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):
|
|
@@ -34,13 +45,14 @@ scripts/repo-browser/stop.sh
|
|
|
34
45
|
|
|
35
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.
|
|
36
47
|
|
|
37
|
-
The catalog
|
|
48
|
+
The catalog renders the project readme first, then every preview grouped by section (Brand, Colors, Components, Spacing, Type).
|
|
38
49
|
|
|
39
50
|
## npm package
|
|
40
51
|
|
|
41
52
|
This repository publishes `@felan-ai/design-system`, which contains the
|
|
42
53
|
canonical CSS, tokens, Felan-owned assets, reusable quote template, design
|
|
43
|
-
specification,
|
|
54
|
+
specification, and shared `@shadcn/lint` policy. The agent skill is installed
|
|
55
|
+
separately from GitHub and is not part of the npm package.
|
|
44
56
|
|
|
45
57
|
```sh
|
|
46
58
|
pnpm add @felan-ai/design-system
|
|
@@ -55,7 +67,7 @@ The package's HSL-triplet tokens are consumed with `hsl(var(--token))`.
|
|
|
55
67
|
self-host Geist. Static previews use `colors_and_type.css`, which also loads
|
|
56
68
|
Geist from Google Fonts. Public exports are documented in the package README
|
|
57
69
|
and include `./styles.css`, `./tokens.css`, `./colors_and_type.css`, `./spec`,
|
|
58
|
-
`./
|
|
70
|
+
`./assets/*`, `./templates/quote.html`, and `./eslint/shadcn`.
|
|
59
71
|
|
|
60
72
|
See [`docs/consuming.md`](docs/consuming.md) for the complete export table,
|
|
61
73
|
package exclusions, lint limitations, asset policy, and consumer rollout.
|
|
@@ -77,6 +89,6 @@ Tailwind 4 migration. `go-to-market` consumes the assets and templates only.
|
|
|
77
89
|
- The design medium is HTML/CSS/JS **prototypes** — reference implementations to match visually, not production code to copy structurally.
|
|
78
90
|
- The reusable commercial quote template lives in `project/templates/quote/`; see its README for
|
|
79
91
|
placeholders and print instructions.
|
|
80
|
-
-
|
|
92
|
+
- The repo browser derives catalog metadata from each preview's `@dsCard` comment, so previews stay in sync without generated files.
|
|
81
93
|
- Static previews load Geist Sans/Mono from the Google Fonts CDN; production consumers provide their own font files.
|
|
82
|
-
- `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,7 +24,6 @@
|
|
|
24
24
|
"project/tokens.css",
|
|
25
25
|
"project/colors_and_type.css",
|
|
26
26
|
"project/README.md",
|
|
27
|
-
"project/SKILL.md",
|
|
28
27
|
"lint",
|
|
29
28
|
"project/assets/felan-logo.svg",
|
|
30
29
|
"project/assets/felan-logo.png",
|
|
@@ -44,7 +43,6 @@
|
|
|
44
43
|
"./tokens.css": "./project/tokens.css",
|
|
45
44
|
"./colors_and_type.css": "./project/colors_and_type.css",
|
|
46
45
|
"./spec": "./project/README.md",
|
|
47
|
-
"./skill": "./project/SKILL.md",
|
|
48
46
|
"./lint-policy": "./lint/shadcn-policy.json",
|
|
49
47
|
"./eslint/shadcn": "./lint/eslint-shadcn.mjs",
|
|
50
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,7 +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
|
-
├── SKILL.md ← skill contract for Claude Code / agents
|
|
240
239
|
├── tokens.css ← canonical tokens + semantic type classes
|
|
241
240
|
├── colors_and_type.css ← preview entry with hosted Geist fonts
|
|
242
241
|
├── styles.css ← font-free production entry
|
package/project/SKILL.md
DELETED
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: felan-design
|
|
3
|
-
description: Use this skill to generate well-branded interfaces and assets for Felan, the agentic engineering platform (the team layer for AI-native software development) — for production or throwaway prototypes/mocks/decks. Contains design guidelines, colors, type, fonts, and assets.
|
|
4
|
-
user-invocable: true
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
Read the README.md file within this skill, and explore the other available files.
|
|
8
|
-
|
|
9
|
-
If creating visual artifacts (slides, mocks, throwaway prototypes, etc), copy assets out and create static HTML files for the user to view. If working on production code, you can copy assets and read the rules here to become an expert in designing with this brand.
|
|
10
|
-
|
|
11
|
-
If the user invokes this skill without any other guidance, ask them what they want to build or design, ask some questions, and act as an expert designer who outputs HTML artifacts _or_ production code, depending on the need.
|
|
12
|
-
|
|
13
|
-
## What Felan is
|
|
14
|
-
|
|
15
|
-
An agentic engineering platform — the team layer for AI-native software development. Copilots made individual engineers faster; Felan gives the engineering team cloud background agents that carry delegated work forward, share team knowledge, follow guardrails (permissions, approvals, audit logs), and improve from feedback — inside Slack, GitHub/GitLab, Linear, Jira, CI, and docs. Anchor line: **Copilots make engineers faster. Felan makes the engineering team faster.** Qualify audience by AI adoption, not headcount. Bugzy (the QA agent) is *one agent under the Felan canopy*, never the platform.
|
|
16
|
-
|
|
17
|
-
## What's in here
|
|
18
|
-
|
|
19
|
-
- `README.md` — voice, tone, visual foundations, iconography, content fundamentals
|
|
20
|
-
- `tokens.css` — canonical HSL tokens (light + dark) and semantic typography classes
|
|
21
|
-
- `colors_and_type.css` — preview entry that adds hosted Geist fonts
|
|
22
|
-
- `assets/` — logo (`felan-logo.svg`/`.png`, forest-green geometric mark), app icons, customer marks, integration SVGs
|
|
23
|
-
- `preview/` — design-system cards: colors, type, spacing, components, brand
|
|
24
|
-
|
|
25
|
-
## Quick rules
|
|
26
|
-
|
|
27
|
-
- Green `hsl(152 44% 26%)` is the **only** accent. One green CTA per screen.
|
|
28
|
-
- Warm neutrals only — hue 20–30 on every gray. Never pure gray.
|
|
29
|
-
- Marketing = forced dark mode with soft radial green+blue orbs. Product app = light default, dark supported.
|
|
30
|
-
- Type = Geist Sans + Geist Mono. Display is `font-weight: 800`, `letter-spacing: -0.025em`, with a white→white/70 gradient text fade on big H1s.
|
|
31
|
-
- Icons = **Lucide** outline, 2px stroke, 16px inline / 20px header / 40px tile.
|
|
32
|
-
- Radii: 6px button, 12px card, full pill. Mostly flat; hover-lift on cards; brand glow on featured CTAs only.
|
|
33
|
-
- Logo is a **geometric aperture mark** (ring + center dot + orbiting dot), forest green. On dark, sit it on a cream tile. Not a monogram.
|
|
34
|
-
- Voice: calm authority, zero hype. Em-dashes, sentence-case subheads, no emoji in chrome. Say what changes for the *team*, not that it's "AI".
|
|
35
|
-
- Words to use: background agent, session, delegate, automation, trigger, guardrails, approvals, audit log, team memory, SDLC, repo, rollout. Retire QA-era words (coverage gap, regression, triage, flaky, pass rate) except inside an explicit QA example.
|
|
36
|
-
- Name agents by SDLC role: Developer, QA, SRE, General Purpose agent.
|
|
37
|
-
- Only make claims structurally true from the brief: "Start with one repo", "Works in Slack, GitHub, Linear, Jira", "Every agent action logged". No Bugzy-era proof claims (no "5-minute setup", "SOC2 ready", "EUR 250/month", "dev/QA ratio >8:1"). Mark illustrative numbers as sample copy. Never "10x", never invented customer metrics. Legal line: "© 2026 Felan".
|