@setoelkahfi / sigit
Code Commits Pulls CI/CD 232
main
claude/code-feature-parity-q003hm claude/elegant-carson-l1menh claude/sigit-acp-local-chat-cx6380 claude/sigit-cloud-agent-expansion-reox0a claude/tool-permission-system claude/zen-feynman-0u78dk development feature/agent-tools-multiedit-glob-todos-remember feature/background-commands feature/commit-coauthor-attribution feature/headless-mode feature/init-command feature/load-local-model-explicitly feature/session-persistence-compaction feature/sigit-code-cloud feature/subagent-tool feature/tool-permission-system feature/tui-repo-tabs feature/tui-tabs main release/v1.3.1
md 203 lines 5.13 KB
Rendered Raw
1 ---
2 name: branding
3 description: Keep siGit Code branding, naming, and package references consistent. Use when editing docs, release notes, UI copy, package metadata, setup guides, or any prose that mentions the product, CLI, company, or Onde Inference.
4 ---
5
6 # Branding
7
8 ## Overview
9
10 Use this file when writing docs, release notes, UI copy, package metadata, or setup guides for this repository.
11
12 The short version:
13
14 - **Product / brand name:** `siGit Code`
15 - **CLI command:** `sigit`
16 - **Rust crate:** `sigit`
17 - **npm package:** `@smbcloud/sigit`
18 - **PyPI package:** `sigit-code`
19 - **Company name:** `smbCloud`
20 - **LLM backend name:** `Onde Inference`
21
22 The most common mistake is mixing the product name with the command name.
23
24
25 ---
26
27 # Branding: siGit Code naming and voice
28
29 Use this skill when you are writing docs, release notes, UI copy, package descriptions, setup guides, or anything else user-facing in this repo.
30
31 The main job is simple: keep the names straight.
32
33 ## The name map
34
35 These names are case-sensitive.
36
37 - **Product / brand:** `siGit Code`
38 - **CLI command:** `sigit`
39 - **Rust crate:** `sigit`
40 - **Repository slug:** `getsigit/sigit`
41 - **npm package:** `@smbcloud/sigit`
42 - **PyPI package:** `sigit-code`
43 - **Company:** `smbCloud`
44 - **LLM backend in prose:** `Onde Inference`
45 - **Rust crate for the backend:** `onde`
46 - **Protocol acronym:** `ACP`
47 - **Long form when needed:** `Agent Client Protocol (ACP)`
48
49 ## First rule
50
51 When you mean the product, write **`siGit Code`** exactly like that.
52
53 Correct:
54
55 - `siGit Code is a local coding agent.`
56 - `siGit Code works in Zed over ACP.`
57 - `siGit Code shares its model cache with the desktop app on macOS.`
58
59 Wrong:
60
61 - `Sigit Code`
62 - `SiGit Code`
63 - `siGit`
64 - `sigit Code`
65 - `SIGIT`
66
67 Do not shorten the product name to just `siGit` in docs or marketing copy unless there is a very specific reason and the sentence still reads clearly.
68
69 ## Second rule
70
71 When you mean something users type, install, import, or clone, use the literal lowercase name.
72
73 That means:
74
75 - `sigit` for the command, crate, and repo slug
76 - `@smbcloud/sigit` for npm
77 - `sigit-code` for PyPI
78 - `onde` for the Rust crate
79
80 Examples:
81
82 - Run `sigit` in a terminal.
83 - Install with `cargo install sigit`.
84 - Install with `npm install -g @smbcloud/sigit`.
85 - Install with `pip install sigit-code`.
86 - The repository is `getsigit/sigit`.
87
88 A good gut-check:
89
90 > If this is the thing a user types or installs, keep the literal package or command name.
91 > If this is the thing you are describing, use the branded product name.
92
93 ## Preferred wording
94
95 Keep the prose plain and direct.
96
97 Prefer:
98
99 - `siGit Code is a local coding agent.`
100 - `siGit Code runs on your machine.`
101 - `siGit Code works with any codebase.`
102 - `Install siGit Code with Cargo:`
103 - `To start siGit Code, run `sigit`.`
104
105 Avoid:
106
107 - `siGit is a local coding agent.`
108 - `sigit is a coding assistant.`
109 - `The siGit product...`
110 - inflated marketing language that makes the copy sound generic
111
112 If a sentence feels awkward because of the brand name, rewrite the sentence. Do not change the name.
113
114 ## Editor setup rules
115
116 In UI-facing examples, the visible label should stay `siGit Code`.
117 The executable should stay `sigit`.
118
119 Example:
120
121 ```/dev/null/branding-example.json#L1-8
122 {
123 "agent_servers": {
124 "siGit Code": {
125 "type": "custom",
126 "command": "/absolute/path/to/sigit"
127 }
128 }
129 }
130 ```
131
132 The same rule applies in VS Code ACP examples, screenshots, panel labels, and release notes.
133
134 ## Other names that must stay exact
135
136 ### smbCloud
137
138 Always write `smbCloud` with lowercase `smb` and uppercase `C`.
139
140 Wrong:
141
142 - `SMBCloud`
143 - `SmbCloud`
144 - `smbcloud`
145
146 ### Onde Inference
147
148 Use `Onde Inference` when you mean the product or project.
149 Use `onde` when you mean the Rust crate.
150
151 Examples:
152
153 - `siGit Code uses Onde Inference as its local LLM backend.`
154 - `The Rust dependency is `onde`.`
155
156 ### ACP
157
158 Use `ACP` for the acronym.
159 Use `Agent Client Protocol (ACP)` on first mention when the long form helps.
160
161 ## Humanizing without breaking branding
162
163 If you are also cleaning up AI-ish writing, preserve every case-sensitive name exactly as written.
164
165 That includes:
166
167 - `siGit Code`
168 - `smbCloud`
169 - `Onde Inference`
170 - `ACP`
171 - `sigit`
172 - `@smbcloud/sigit`
173 - `sigit-code`
174 - `onde`
175
176 Do not "smooth out" a brand name. Do not re-case package names to make a sentence look nicer. Rewrite around them.
177
178 ## Quick checklist
179
180 Before you finish any doc or release-note edit, check these:
181
182 1. Did you use `siGit Code` when referring to the product?
183 2. Did you keep `sigit` lowercase for commands, crates, and repo references?
184 3. Did you keep `@smbcloud/sigit` and `sigit-code` exact?
185 4. Did you keep `smbCloud` and `Onde Inference` cased correctly?
186 5. In setup examples, does the visible editor label say `siGit Code` while the command stays `sigit`?
187
188 ## Fast replacements
189
190 Common fixes:
191
192 - `siGit is` -> `siGit Code is`
193 - `siGit works` -> `siGit Code works`
194 - `siGit knows` -> `siGit Code knows`
195 - `On macOS, siGit` -> `On macOS, siGit Code`
196 - `Sigit` -> usually `siGit Code` or `sigit`, depending on context
197
198 When in doubt, ask one question:
199
200 > Am I talking about the product, or the literal thing a user types?
201
202 If it is the product, use `siGit Code`.
203 If it is the command or package, use the exact lowercase name.