mirror of
https://github.com/nexu-io/open-design.git
synced 2026-09-20 06:15:06 +08:00
chaoxiaoche
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# GitHub Usage
|
|
|
|
Design System 2.0 package guide for Open Design agents and reviewers.
|
|
|
|
## Read Order
|
|
|
|
1. Read this file first to understand the package contract.
|
|
2. Read `DESIGN.md` for visual intent, constraints, and anti-patterns.
|
|
3. Paste `tokens.css` into the first artifact `<style>` block before writing component CSS.
|
|
4. Use `components.manifest.json` for the compact component inventory; open `components.html` when exact selectors or states matter.
|
|
5. Inspect `preview/` pages when a visual sanity check is useful.
|
|
|
|
## Design Highlights
|
|
|
|
- True white canvas (`#ffffff`) or deep navy-black (`#0d1117`) — no warmth, no tint
|
|
- Hairline gray borders (`#d0d7de`) define every pane and panel
|
|
- Primer blue (`#0969da`) for links/primary; GitHub green (`#1a7f37`) for success/merge
|
|
- Dense list rows with minimal padding; whitespace is rare
|
|
|
|
## Do
|
|
|
|
- Preserve the schema token names exactly so cross-brand switching stays reliable.
|
|
- Use `--accent` for primary actions, links, focus states, and one clear focal element.
|
|
- Reuse component groups from `components.manifest.json` before inventing new controls.
|
|
- Treat `source/` files as audit evidence for the bundled fixture backfill.
|
|
|
|
## Avoid
|
|
|
|
- Avoid raw hex values outside the copied `:root` token block.
|
|
- Avoid redefining Tailwind or design-token values independently of `tokens.css`.
|
|
- Avoid claiming original upstream source evidence; this package is based on the curated bundled fixture.
|
|
- Avoid adding new component recipes that are not represented in `components.html` or `DESIGN.md`.
|