Skip to content

Commit be503b1

Browse files
docs: fun emoji UX plus light-theme contrast fix
Punch up every page with humor and emoji navigation, refresh the premium theme, and hard-fix light-mode CTA/tab contrast so secondary buttons stay readable on pale backgrounds.
1 parent f846762 commit be503b1

22 files changed

Lines changed: 1367 additions & 590 deletions

‎README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -182,17 +182,17 @@ TUI: `/compact`, `/sessions`, `/stats`, `/permission`, `/agents`, `/stop`, `/res
182182

183183
## 📚 Docs
184184

185-
**Premium site (MkDocs Material → GitHub Pages):**
186-
[unicolab.github.io/smlcode](https://unicolab.github.io/smlcode/)
185+
**Premium + playful site (MkDocs Material → GitHub Pages):**
186+
☀️ [unicolab.github.io/smlcode](https://unicolab.github.io/smlcode/)
187187

188188
| Section | Pages |
189189
|---------|--------|
190-
| Getting started | Install · Quick start · Concepts · Providers |
191-
| Handbook | Guide · TUI · Skills · Studio · Agents · Recipes |
192-
| Reference | CLI · Config · Testing · FAQ |
193-
| Internals | Architecture · Contributing |
190+
| 🚀 Getting started | 📦 Install · ⏱️ Quick start · 🧠 Concepts · 🔌 Providers |
191+
| 📘 Handbook | 🧭 Guide · 🖥️ TUI · 🦋 Skills · 🎨 Studio · 🧩 Agents · 🧪 Recipes |
192+
| 📚 Reference | ⌨️ CLI · ⚙️ Config · ✅ Testing · ❓ FAQ |
193+
| 🔧 Internals | 🏗️ Architecture · 🤝 Contributing |
194194

195-
Local preview: `make docs-serve` → http://127.0.0.1:8000
195+
Local preview: `make docs-serve` → http://127.0.0.1:8000 — bring snacks. 🍿
196196

197197
---
198198

‎docs/agents.md‎

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,35 @@
11
# 🧩 Agents
22

3-
Fourteen specialists. Scoped packs. No “hold the monorepo in your head” cosplay.
3+
Fourteen specialists. Scoped packs. No “hold the monorepo in your head” cosplay. 🎭
44

5-
!!! tip "Mix brains"
6-
Cheap local explorer + sharper cloud reviewer in one run — [Providers](providers.md).
5+
<div class="slm-banner" markdown>
6+
<span class="slm-banner__emoji">🧬</span>
7+
<p class="slm-banner__text" markdown>
8+
<strong>Mix brains:</strong> cheap local explorer + sharper cloud reviewer in one run —
9+
see <a href="providers.md">Providers</a>. Budget diplomacy is a feature.
10+
</p>
11+
</div>
712

813
---
914

10-
## Roster
15+
## Roster 📋
1116

1217
| ID | Tools | Output | When |
1318
|----|-------|--------|------|
14-
| `coordinator` | — | JSON actions | Pre-exec + each wave |
19+
| `coordinator` | — | JSON actions | Pre-exec + each wave 🧭 |
1520
| `orchestrator` | — | decisions | Reserved |
16-
| `context` | — | CONTEXT body | Run start |
17-
| `explorer` | ✅ | file map | Deep explore |
18-
| `docs` | ✅ | docs map | Docs/API queries |
19-
| `architect` | — | design JSON | Large/refactor |
20-
| `planner` | — | plan JSON | Always |
21-
| `splitter` | — | tasks JSON | Always |
22-
| `worker` | ✅ | status | Execute |
23-
| `deep` | ✅ | status | Multi-step |
24-
| `reviewer` | — | approve JSON | Critic |
25-
| `corrector` | ✅ | status | On reject |
26-
| `tester` | ✅ | passed | End validation |
27-
| `memory` | — | bullets | Learn |
21+
| `context` | — | CONTEXT body | Run start 📝 |
22+
| `explorer` | ✅ | file map | Deep explore 🔎 |
23+
| `docs` | ✅ | docs map | Docs/API queries 📚 |
24+
| `architect` | — | design JSON | Large/refactor 🏛️ |
25+
| `planner` | — | plan JSON | Always 📋 |
26+
| `splitter` | — | tasks JSON | Always ✂️ |
27+
| `worker` | ✅ | status | Execute 🛠️ |
28+
| `deep` | ✅ | status | Multi-step 🧪 |
29+
| `reviewer` | — | approve JSON | Critic 🔍 |
30+
| `corrector` | ✅ | status | On reject 🔧 |
31+
| `tester` | ✅ | passed | End validation ✅ |
32+
| `memory` | — | bullets | Learn 💾 |
2833

2934
```bash
3035
curl -s localhost:7420/api/agents | jq '.[].id'
@@ -33,7 +38,7 @@ curl -s localhost:7420/api/agents | jq '.[].id'
3338

3439
---
3540

36-
## Custom agents
41+
## Custom agents ✨
3742

3843
`.slmcode/agents/<id>.yaml` or `~/.slmcode/agents/`.
3944

@@ -49,7 +54,7 @@ Different endpoints → unique backend keys (no accidental shared gateway).
4954

5055
---
5156

52-
## Coordinator actions
57+
## Coordinator actions 🧭
5358

5459
```json
5560
{
@@ -64,9 +69,11 @@ Different endpoints → unique backend keys (no accidental shared gateway).
6469
}
6570
```
6671

72+
Air-traffic control, not pilot. Let workers fly the plane.
73+
6774
---
6875

69-
## Delegating
76+
## Delegating 📬
7077

7178
```bash
7279
slmcode task add "Deep refactor auth" --role deep --column ready_to_dev
@@ -75,7 +82,7 @@ slmcode task delegate T1 docs
7582

7683
---
7784

78-
## Project instructions
85+
## Project instructions 📜
7986

8087
Auto-loaded from:
8188

@@ -84,14 +91,14 @@ Auto-loaded from:
8491
- `.cursorrules`
8592
- `.slmcode/PROJECT.md`
8693

87-
!!! example "Tiny AGENTS.md"
94+
!!! example "✨ Tiny AGENTS.md"
8895
```markdown
8996
# Agents
9097
- Tiny, reviewable diffs
9198
- No drive-by refactors
9299
- Match existing style
93100
```
94101

95-
→ [Skills](skills.md) · [Concepts](concepts.md)
102+
→ [🦋 Skills](skills.md) · [🧠 Concepts](concepts.md)
96103

97-
Made with ♥ by [UnicoLab](https://unicolab.ai)
104+
☀️ Made with ♥ by [UnicoLab](https://unicolab.ai)

‎docs/architecture.md‎

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
11
# 🏗️ Architecture
22

3-
How SLMCode stays sharp when the model is small, tired, or both.
3+
How SLMCode stays sharp when the model is small, tired, or both. 😴➡️😎
4+
5+
<div class="slm-banner" markdown>
6+
<span class="slm-banner__emoji">🦃</span>
7+
<p class="slm-banner__text" markdown>
8+
<strong>Design thesis:</strong> routing in Go. Tiny packs per specialist. Disk evidence over vibes.
9+
If you stuff the whole repo into context, don’t be surprised when the model naps.
10+
</p>
11+
</div>
412

513
---
614

7-
## Design thesis
15+
## Design thesis 🧠
816

917
30B-class SLMs fail when asked to “be a frontier agent” in one free-form loop.
1018

1119
**Routing in Go. Tiny packs per specialist. Disk evidence over vibes.**
1220

13-
!!! quote "Turkey rule"
21+
!!! quote "🦃 Turkey rule"
1422
If you stuff the whole repo into context, don't be surprised when the model naps.
1523

16-
→ Narrative version: [Concepts](concepts.md)
24+
→ Narrative version: [🧠 Concepts](concepts.md)
1725

1826
---
1927

20-
## Package map
28+
## Package map 📦
2129

2230
```text
2331
cmd/slmcode CLI + embedded Studio (go:embed ui/)
@@ -46,28 +54,29 @@ pkg/retrieval Embeddings / lexical ranking
4654

4755
---
4856

49-
## Live streaming
57+
## Live streaming 📡
5058

5159
`stream.Event` fields: `phase`, `kind`, `agent`, `task_id`, `scope`, `output`.
5260
Consumers: CLI, Studio SSE (`/api/events`), `/api/runs/latest`.
5361

5462
---
5563

56-
## Explore reuse · critic · flywheel
64+
## Explore reuse · critic · flywheel 🔁
5765

58-
- **Reuse** when CONTEXT/MEMORY are rich (override with `SLMCODE_FORCE_EXPLORE=1`)
59-
- **Critic**: worker → reviewer → corrector loop; disk evidence preferred
60-
- **Flywheel**: MEMORY / CONTEXT / SKILLS / sessions after each run
66+
- **Reuse** when CONTEXT/MEMORY are rich (override with `SLMCODE_FORCE_EXPLORE=1`) ♻️
67+
- **Critic**: worker → reviewer → corrector loop; disk evidence preferred 🔍
68+
- **Flywheel**: MEMORY / CONTEXT / SKILLS / sessions after each run 🦋
6169

6270
---
6371

64-
## Parallelism
72+
## Parallelism ⚡
6573

6674
`SubAgentExecutor` runs ready tasks up to `max_parallel`. Soft-skip blocked deps so one stuck locate can't freeze the board.
75+
One blocked task should not become a board-wide existential crisis.
6776

6877
---
6978

70-
## Embed
79+
## Embed 🧩
7180

7281
```go
7382
import "github.com/UnicoLab/slmcode/pkg/harness"
@@ -79,6 +88,6 @@ res, err := h.Run(ctx, "refactor pkg/auth")
7988

8089
Dependency: `github.com/piotrlaczkowski/GoLangGraph` (optional local replace for hacking).
8190

82-
→ [Contributing](contributing.md)
91+
→ [🤝 Contributing](contributing.md)
8392

84-
Made with ♥ by [UnicoLab](https://unicolab.ai)
93+
☀️ Made with ♥ by [UnicoLab](https://unicolab.ai)

‎docs/cli.md‎

Lines changed: 43 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# ⌨️ CLI reference
22

3-
Binary name: **`slmcode`** (docs sometimes say *smlcode* — same project).
3+
Binary name: **`slmcode`** (docs sometimes say *smlcode* — same project, same vibes). 💚
4+
5+
<div class="slm-banner" markdown>
6+
<span class="slm-banner__emoji">🛠️</span>
7+
<p class="slm-banner__text" markdown>
8+
<strong>Power-user tip:</strong> every command has <code>--help</code>.
9+
When in doubt, be loud with <code>-v</code> and green with <code>doctor</code>.
10+
</p>
11+
</div>
412

513
```bash
614
slmcode --help
@@ -9,7 +17,7 @@ slmcode <command> --help
917

1018
---
1119

12-
## Global flags
20+
## Global flags 🌐
1321

1422
| Flag | Env / notes |
1523
|------|-------------|
@@ -22,59 +30,59 @@ slmcode <command> --help
2230
| `--parallel` | Max parallel workers |
2331
| `--retries` | Review/correct retries |
2432
| `--think-passes` | Multipass think loops |
25-
| `--dry-run` | Don't write code files |
26-
| `-v` / `--verbose` | Loud agent logs |
33+
| `--dry-run` | Don't write code files 🎭 |
34+
| `-v` / `--verbose` | Loud agent logs 📢 |
2735
| `--no-banner` | Hide ASCII banner on help |
2836

2937
---
3038

31-
## Commands
39+
## Commands 📚
3240

33-
### Core loop
41+
### Core loop 🔁
3442

3543
| Command | Purpose |
3644
|---------|---------|
37-
| `slmcode` / `tui` | Premium interactive TUI (**default**) |
38-
| `run` | Full pipeline or single specialist |
39-
| `chat` | Classic REPL |
40-
| `studio` | GUI + HTTP/SSE (`--listen host:port`) |
41-
| `doctor` | Provider/model/workspace health |
42-
| `init` | Create `.slmcode/` scaffolding |
43-
| `update` | Refresh binary (release) or rebuild from source |
45+
| `slmcode` / `tui` | Premium interactive TUI (**default**) 🖥️ |
46+
| `run` | Full pipeline or single specialist 🚀 |
47+
| `chat` | Classic REPL 💬 |
48+
| `studio` | GUI + HTTP/SSE (`--listen host:port`) 🎨 |
49+
| `doctor` | Provider/model/workspace health 🩺 |
50+
| `init` | Create `.slmcode/` scaffolding 🌱 |
51+
| `update` | Refresh binary (release) or rebuild from source ⬆️ |
4452
| `version` | Print version metadata |
4553

46-
### Board & tasks
54+
### Board & tasks 📋
4755

4856
| Command | Purpose |
4957
|---------|---------|
5058
| `board` | Show kanban |
51-
| `watch` | Live-refreshing kanban |
59+
| `watch` | Live-refreshing kanban 👀 |
5260
| `task` | add / show / edit / move / delegate / checklist / promote |
5361
| `status` | Query + plan head + board counts |
5462
| `plan` | Show `PLAN.md` |
5563

56-
### Memory & skills
64+
### Memory & skills 💾
5765

5866
| Command | Purpose |
5967
|---------|---------|
6068
| `context` | Show / edit `CONTEXT.md` |
6169
| `docs` | List / show / edit markdown memory |
62-
| `skills` | List / show / new / edit |
63-
| `session` | list / show / resume |
70+
| `skills` | List / show / new / edit 🦋 |
71+
| `session` | list / show / resume 🛟 |
6472

65-
### Git helpers & safety
73+
### Git helpers & safety 🛡️
6674

6775
| Command | Purpose |
6876
|---------|---------|
6977
| `diff` | Working tree diff |
7078
| `commit` | `git add -A && commit` helper |
7179
| `apply` | Apply `.slmcode/pending/` (review mode) |
72-
| `config` | Show / set harness config |
80+
| `config` | Show / set harness config ⚙️ |
7381
| `completion` | Shell completion scripts |
7482

7583
---
7684

77-
## `run` deep dive
85+
## `run` deep dive 🚀
7886

7987
```bash
8088
slmcode run -v "add JWT auth"
@@ -97,7 +105,7 @@ Query sugar: `@skill:name`, `@file:path`, `@folder:path` (when supported by inst
97105

98106
---
99107

100-
## `config`
108+
## `config` ⚙️
101109

102110
```bash
103111
slmcode config # show
@@ -106,22 +114,22 @@ slmcode config set model qwen2.5-coder:14b
106114
slmcode config set permission review
107115
```
108116

109-
Full field list → [Config reference](config.md).
117+
Full field list → [⚙️ Config reference](config.md).
110118

111119
---
112120

113-
## `doctor` reads as
121+
## `doctor` reads as 🩺
114122

115-
- Active provider / model / endpoint
116-
- Reachability
117-
- Embedding mode (`openai` / `local` / `lexical`)
118-
- Workspace / board / skills sanity
123+
- Active provider / model / endpoint
124+
- Reachability
125+
- Embedding mode (`openai` / `local` / `lexical`)
126+
- Workspace / board / skills sanity
119127

120-
Green → ship. Red → [FAQ](faq.md).
128+
Green → ship. 💚 Red → [❓ FAQ](faq.md).
121129

122130
---
123131

124-
## Completions
132+
## Completions 🐚
125133

126134
```bash
127135
slmcode completion zsh > "$(brew --prefix)/share/zsh/site-functions/_slmcode"
@@ -133,6 +141,9 @@ Installers may place these automatically on system installs.
133141

134142
---
135143

136-
## Exit philosophy
144+
## Exit philosophy 🚪
145+
146+
SLMCode prefers **visible failure** over silent “done” theater.
147+
Check the board, the diff, and `doctor` when something smells off. 👃
137148

138-
SLMCode prefers **visible failure** over silent “done” theater. Check the board, the diff, and `doctor` when something smells off.
149+
☀️ Made with ♥ by [UnicoLab](https://unicolab.ai)

0 commit comments

Comments
 (0)