mirror of
https://github.com/nexu-io/open-design.git
synced 2026-09-20 06:15:06 +08:00
Joey-nexu
f1a0b60c6c
* chore: unify product name display to OpenDesign repo-wide Rename the user-facing product name from "Open Design" to "OpenDesign" across documentation, web/desktop UI strings, i18n locales, prompts, plugin/skill/design-system content, changelogs, and specs, matching the landing-page rename already in flight. Deliberately excluded so installed-app identity stays untouched: - packages/release PRODUCT_NAME and everything derived from it (app bundle names, installer/registry identity, updater feeds) - tools/pack, tools/release, apps/packaged, landing page (PR #6983) - mocks/ recorded traces and LICENSE - test fixtures and comments that encode real on-disk install paths (Open Design.app, Program Files\Open Design, AppData paths) Validated with pnpm guard, pnpm typecheck, and targeted web/desktop/host test runs over the renamed strings. * fix(web): keep two-letter author monogram for CamelCase brand names authorInitials split words on whitespace only, so the renamed single-token author name "OpenDesign" produced a one-letter monogram. Treat lower-to-upper CamelCase boundaries as word breaks so the avatar fallback stays "OD". * fix(release): restore spaced Windows source artifact names in win.ps1 tools/pack still derives builder outputs from the unchanged PRODUCT_NAME ("Open Design"), so the asset script must look for the spaced filenames. Matches the mac/mac-intel/linux asset scripts, which were already kept on the original names. --------- Co-authored-by: Joey <236967869+joeylee12629-star@users.noreply.github.com>
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# GitHub Usage
|
|
|
|
Design System 2.0 package guide for OpenDesign 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`.
|