Skip to content

docs: the UI follows the private design repository #277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kinqsradio merged 1 commit into from
Nov 8, 2026
Merged

docs: the UI follows the private design repository #277

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ This repository is the orbyn.dev site. Read [README.md](README.md) and
- Build and check: `node scripts/build-site.mjs --check`. The check fails on a
broken link, inline style or script (the CSP blocks them), a GitHub link
outside `orbyn-dev`, or wording that suggests something is out or for sale.
- Copy, tokens, spacing and motion come from the internal designs. Do not
invent copy, states, dates, sign-ups or download and buy buttons.
- Designs: the UI follows the private repository orbyn-dev/orbyn-designs, the one source of truth: `artifacts/` holds the published designs, `artifacts.json` indexes them, and `briefs/` holds the design-match brief. Read it from a current clone (`git pull` first), never from a copy in a temp folder, and never edit `artifacts/` here. Match the designs exactly, in Light, Dark and Dim, including copy and motion; take every value from the design source. A UI change cites the artifact version and frame ids it builds, or links the design pull request there. Anything not designed or not in the plan goes to the Orbyn Product UI/UX Designer before it is built; never invent it. The repository is private, so a contributor without access gets the frames they need in their issue. Public files never link the private plan or the design artifact pages (say "internal designs").
- Do not invent copy, states, dates, sign-ups or download and buy buttons.
- No product is out yet. Keep every app at Building and Teams at Planned until
the owner says otherwise.
- Never commit `.env` or `.env.production`, and never print their values.
- `scripts/deploy.sh` deletes the old app's data. Run `--check` first, and only
run it on a host you were asked to deploy to.
- Public files never link private plan or design documents; say "internal designs".
- Commit messages never carry AI attribution trailers; disclose AI use in the PR
body only. Write your own squash message when merging (`gh pr merge --subject --body`).
Loading