Repository navigation
Commit 61a71e9
authored
Genericize setup-specific examples and calm documentation emphasis (#100)
Ahead of opening the repo to external contributors, this sweeps the
codebase and docs so nothing reads as tied to one particular deployment
or reflects the scar tissue of past incidents.
## What changed
- **Genericized setup-specific example names** — placeholder hostnames,
realm/channel names, agent names, and sample identifiers in docs,
comments, and tests now use neutral illustrative values instead of names
from one specific setup.
- **Calmed documentation and comment emphasis** — trimmed defensive
CAPS, "never/always" absolutes, and repeated caveats that encoded a past
problem rather than what a fresh reader needs. The prose now explains
what and why, not the history that motivated a given line.
The sweep spans `packages/` (mcp, zulip, core, testing, memory),
`clients/` (hermes, claude-code), the docs set, and root-level files
(README, AGENTS, flake).
## No behaviour change
Purely documentation, comments, and example/placeholder values — no
runtime logic is touched. The full `check` gate (typecheck → lint →
test, 920 tests) is green on the branch.1 parent f1350e2 commit 61a71e9
103 files changed
Lines changed: 1196 additions & 1296 deletions
File tree
- .github/workflows
- biome-plugins
- clients
- claude-code
- .claude-plugin
- hooks
- hermes
- commy
- scripts
- tests
- docs
- packages
- core
- mcp
- memory
- testing
- zulip
- scripts
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
5 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
23 | | - | |
| 22 | + | |
| 23 | + | |
24 | 24 | | |
25 | 25 | | |
26 | | - | |
27 | | - | |
28 | | - | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
29 | 29 | | |
30 | | - | |
31 | | - | |
| 30 | + | |
32 | 31 | | |
33 | | - | |
| 32 | + | |
34 | 33 | | |
35 | 34 | | |
36 | 35 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
71 | 71 | | |
72 | 72 | | |
73 | 73 | | |
74 | | - | |
| 74 | + | |
75 | 75 | | |
76 | 76 | | |
77 | 77 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
90 | 90 | | |
91 | 91 | | |
92 | 92 | | |
93 | | - | |
94 | | - | |
| 93 | + | |
| 94 | + | |
95 | 95 | | |
96 | 96 | | |
97 | 97 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
| 39 | + | |
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
45 | | - | |
| 45 | + | |
46 | 46 | | |
47 | 47 | | |
48 | 48 | | |
| |||
0 commit comments