Canonical instructions for any AI agent (Kilo, Copilot, Claude Code, Cursor, etc.) working in this repo. Read this once per session before making changes.
- This file — how to work here.
- docs/README.md — what's in
docs/. - docs/concepts/brand-manual.md — the brand itself.
- docs/specs/github-asset-setup.md — how consumers wire assets.
- The specific file you need to change.
This repo is the single source of truth for the n3ary / neary visual
identity. The hand-edited source files are under src/ (vector SVGs) and
docs/concepts/ (the prose brand manual). Everything under dist/ is a
build artefact regenerated by pnpm build and must never be hand-edited.
- Edit a source under
src/logo/,src/social/, ordocs/. - Run
pnpm buildto regeneratedist/. - Commit the source change. Never commit
dist/. The CI deploys a freshly builtdist/to branding.n3ary.com on every push tomain.
main is protected. Every change goes through a PR. Squash or rebase
merge only. No merge commits.
The brand is org-wide. Any change to src/logo/neary-logo.svg (the
primary mark) ripples to every consumer. Review the impact in the PR
description before merging.
This is a small repo. Default to working on the current branch. See n3ary/standards agent-worktrees.md for when a worktree is justified.
The site/ directory is what branding.n3ary.com serves. The deploy
workflow ships site/ + dist/ to Cloudflare Pages on every push to
main. Don't put anything sensitive in site/.
Before opening a PR that touches anything under .github/, run
gh pr list --state open to confirm no in-flight PR is already
refactoring CI on the same files. Two parallel CI refactors both
end up stale — one of them lands, the other gets closed.
The full org standards are at n3ary/standards. We don't vendor them here — this repo is too small to need local copies, and the link above is always current.