@hej / sigit
Code Commits Issues Pulls Sessions CI/CD
main
development feature/crates-release feature/v1.0.4 main
md 178 lines 3.86 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 ## Primary rule
27
28 When you mean the product, write **`siGit Code`** exactly like that.
29
30 Correct:
31
32 - `siGit Code is a local coding agent.`
33 - `siGit Code works in Zed over ACP.`
34 - `siGit Code shares its model cache with the desktop app on macOS.`
35
36 Wrong:
37
38 - `Sigit Code`
39 - `SiGit Code`
40 - `siGit`
41 - `sigit Code`
42 - `SIGIT`
43
44 Do not shorten the product name to just `siGit` in documentation or marketing copy unless there is a very specific reason and the surrounding text makes it unmistakable.
45
46 ---
47
48 ## Use lowercase names for commands and packages
49
50 Use lowercase `sigit` when you mean the executable, crate, repo slug, or package name.
51
52 Examples:
53
54 - Run `sigit` in a terminal.
55 - Install with `cargo install sigit`.
56 - Install with `npm install -g @smbcloud/sigit`.
57 - Install with `pip install sigit-code`.
58 - The repository is `getsigit/sigit`.
59
60 This distinction matters:
61
62 - **Brand / product:** `siGit Code`
63 - **Command / package / repo:** `sigit`
64
65 ---
66
67 ## Recommended wording patterns
68
69 ### Product description
70
71 Prefer:
72
73 - `siGit Code is a local coding agent.`
74 - `siGit Code runs on your machine.`
75 - `siGit Code works with any codebase.`
76
77 Avoid:
78
79 - `siGit is a local coding agent.`
80 - `sigit is a coding assistant.`
81 - `The siGit product...`
82
83 ### Install instructions
84
85 Prefer:
86
87 - `Install siGit Code with Cargo:`
88 - `Install siGit Code from npm:`
89 - To start siGit Code, run `sigit`.
90
91 That keeps the brand name in prose and the command name in code.
92
93 ### Editor setup
94
95 In UI-facing examples, keep the displayed agent name as `siGit Code`.
96
97 Example:
98
99 ```/dev/null/branding-example.json#L1-8
100 {
101 "agent_servers": {
102 "siGit Code": {
103 "type": "custom",
104 "command": "/absolute/path/to/sigit"
105 }
106 }
107 }
108 ```
109
110 The visible name is `siGit Code`. The executable path is `sigit`.
111
112 ---
113
114 ## Other names that should stay consistent
115
116 ### smbCloud
117
118 Always write `smbCloud` with a lowercase `smb` and uppercase `C`.
119
120 Correct:
121
122 - `smbCloud`
123
124 Wrong:
125
126 - `SMBCloud`
127 - `SmbCloud`
128 - `smbcloud`
129
130 ### Onde Inference
131
132 Use `Onde Inference` when referring to the product or project.
133
134 Use `onde` when referring to the Rust crate.
135
136 Examples:
137
138 - `siGit Code uses Onde Inference as its local LLM backend.`
139 - The Rust dependency is `onde`.
140
141 ### ACP
142
143 Use `ACP` for the protocol acronym.
144
145 Preferred long form:
146
147 - `Agent Client Protocol (ACP)` on first mention when useful
148
149 ---
150
151 ## Copy checklist
152
153 Before you finish any docs or release-note edit, check these quickly:
154
155 1. Did you use `siGit Code` for the product name?
156 2. Did you keep `sigit` lowercase for commands and package names?
157 3. Did you keep `smbCloud` cased correctly?
158 4. Did you keep `Onde Inference` cased correctly in prose?
159 5. In setup examples, does the visible editor label say `siGit Code` while the command stays `sigit`?
160
161 ---
162
163 ## Fast replacements
164
165 Common fixes:
166
167 - `siGit is` -> `siGit Code is`
168 - `siGit works` -> `siGit Code works`
169 - `siGit knows` -> `siGit Code knows`
170 - `On macOS, siGit` -> `On macOS, siGit Code`
171 - `Sigit` -> usually `siGit Code` or `sigit`, depending on context
172
173 When in doubt, ask:
174
175 > Am I talking about the branded product, or the literal command/package name?
176
177 If it is the product, use `siGit Code`.
178 If it is something users type or install, use `sigit`.