Skip to content

Commit ab09b73

Browse files
One-command GIF + exhaustive consistency pass
- Regenerate demo.gif to show the single `curl | bash` install (was the old clone + ./setup.sh flow) - Add the one-command install to the Quickstart intro - Clean up link text: human-readable labels instead of raw ./paths.md - Consistency fixes from a full doc review: - reframe "command" as a manual-only skill (was contradicting the reference) - bridge "three modes" (tutorials) to "six modes" (reference) - add a Related nav footer to every guide (were dead-ends) - uniform "Source:" link format; /resume, /usage(5h), Opus-4.6 wording, de-duplicate Ctrl+R, move /memory out of the prefixes table - allowed-tools comma-separated in command assets (copy-paste correctness) - align setup.sh allowlist with the asset; test suite "(32 checks)" wording Build/lint/shellcheck/tests all green; 0 render anomalies across all pages. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 646d24a commit ab09b73

28 files changed

Lines changed: 70 additions & 53 deletions

assets/commands/commit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: commit
33
description: Stage changes and create a Conventional Commit from the diff. Use when the user wants to commit the current work. Does not push.
4-
allowed-tools: Bash(git add:*) Bash(git status:*) Bash(git diff:*) Bash(git commit:*) Bash(git log:*)
4+
allowed-tools: Bash(git add:*), Bash(git status:*), Bash(git diff:*), Bash(git commit:*), Bash(git log:*)
55
---
66

77
# Commit

assets/commands/review-pr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: review-pr
33
description: Review the current diff for bugs, edge cases, and risks, then suggest concrete fixes. Use before opening or merging a PR. Read-only — makes no changes.
4-
allowed-tools: Bash(git diff:*) Bash(git status:*) Bash(git log:*) Bash(gh pr view:*) Bash(gh pr diff:*)
4+
allowed-tools: Bash(git diff:*), Bash(git status:*), Bash(git log:*), Bash(gh pr view:*), Bash(gh pr diff:*)
55
---
66

77
# Review PR

assets/commands/write-tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: write-tests
33
description: Write focused tests for a given file or function and run them until they pass. Use when asked to add or improve test coverage. Pass the target as an argument, e.g. /write-tests src/auth.ts.
4-
allowed-tools: Bash(npm test:*) Bash(npx vitest:*) Bash(npx jest:*) Bash(pytest:*) Bash(uv run pytest:*) Bash(go test:*)
4+
allowed-tools: Bash(npm test:*), Bash(npx vitest:*), Bash(npx jest:*), Bash(pytest:*), Bash(uv run pytest:*), Bash(go test:*)
55
---
66

77
# Write Tests

docs/cheatsheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ the full reference.
1515
| `/` | Run a slash command or skill (type `/` to list) |
1616
| `@` | Mention a file/folder or MCP resource (`@src/auth.ts`) |
1717
| `!` | Run a shell command; output goes into context |
18-
| `/memory` | Edit persistent memory (project/user [CLAUDE.md](./reference/claude-md.md)) |
1918

2019
## Essential keys
2120

@@ -54,6 +53,7 @@ Fine-grained: `/permissions` → allow/deny patterns like `Bash(npm run test:*)`
5453
| `/help` | List everything |
5554
| `/init` | Generate a `CLAUDE.md` from the codebase |
5655
| `/clear` | New conversation, keep project memory (use between tasks) |
56+
| `/memory` | Edit persistent memory ([CLAUDE.md](./reference/claude-md.md)) |
5757
| `/compact [focus]` | Compress the conversation, keep the essentials |
5858
| `/context` | Show context-window usage |
5959
| `/model` · `/effort` | Switch model · set reasoning effort |

docs/environment/bootstrap-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ claude doctor # check the Claude Code install itself
102102

103103
## The test suite
104104

105-
The script ships with a **32-assertion** test suite that runs `setup.sh` in a temporary `HOME` with mocked commands — no changes to your real system:
105+
The script ships with a **test suite (32 checks)** that runs `setup.sh` in a temporary `HOME` with mocked commands — no changes to your real system:
106106

107107
```bash
108108
./test/run-tests.sh

docs/environment/monitoring-cost-ratelimits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Run `/usage` to see your session token use plus **plan usage bars**:
1313
- A **5-hour window** (the rolling session limit).
1414
- A **weekly window**.
1515

16-
`/usage` also **attributes** usage to what's consuming it — skills, subagents, and MCP servers — so you can see what's expensive. Press **`d`** and **`w`** to switch between the daily and weekly views.
16+
`/usage` also **attributes** usage to what's consuming it — skills, subagents, and MCP servers — so you can see what's expensive. Press **`d`** and **`w`** to switch between the 5-hour and weekly views.
1717

1818
When you're near a limit, `/usage` shows the **time until your window resets**, which is the number you actually plan around.
1919

docs/explanation/context-window.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,6 @@ Your main context stays clean; you get the answer without the clutter. This is o
5757
- `/context` to check before things feel slow.
5858
- **Subagents** for anything that reads a lot of files.
5959

60-
For the full picture on keeping sessions efficient, see [../guides/cost-optimization.md](../guides/cost-optimization.md).
60+
For the full picture on keeping sessions efficient, see [Optimize cost & context](../guides/cost-optimization.md).
6161

62-
**Source:** https://code.claude.com/docs/en/costs
62+
**Source:** [Manage cost & context](https://code.claude.com/docs/en/costs)

docs/explanation/how-claude-works.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ With a verifiable target, each loop iteration moves closer to correct. Without o
3333

3434
## The context window
3535

36-
Everything Claude knows in a session lives in its **context window** — its working memory. It's finite, and performance degrades as it fills. Keeping context lean (clearing between tasks, compacting mid-task) is central to good results. See [./context-window.md](./context-window.md) for the details.
36+
Everything Claude knows in a session lives in its **context window** — its working memory. It's finite, and performance degrades as it fills. Keeping context lean (clearing between tasks, compacting mid-task) is central to good results. See [the context window](./context-window.md) for the details.
3737

3838
## The customization layers
3939

@@ -50,4 +50,4 @@ A simple way to remember the difference: CLAUDE.md is *always* loaded, a skill i
5050

5151
The loop does the work; the layers shape it. Give Claude a clear goal, a lean context, and a way to verify itself, and it behaves like a capable colleague rather than a fancy autocomplete.
5252

53-
**Source:** https://code.claude.com/docs/en/how-claude-code-works
53+
**Source:** [How Claude Code works](https://code.claude.com/docs/en/how-claude-code-works)

docs/explanation/when-to-use-what.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ These look similar but solve different problems:
2525
| Mechanism | Use when… | Trigger |
2626
| --- | --- | --- |
2727
| **Skill** | a capability is **sometimes relevant** and reusable | loads when the task matches |
28-
| **Command** | you want a **named shortcut** you invoke on demand | you type `/name` |
28+
| **Command** | you want a **named shortcut** you invoke yourself (a skill with `disable-model-invocation`) | you type `/name` |
2929
| **Hook** | something must happen **every time**, deterministically | fires automatically on an event |
3030
| **MCP** | you need to **connect an external tool** (database, API, service) | available once configured |
3131

3232
- **Use a skill when** you have know-how that applies now and then — a testing convention, a deploy procedure — and you want Claude to pull it in automatically.
33-
- **Use a command when** you want to trigger something yourself by name.
33+
- **Use a command when** you want a skill that runs *only* when you invoke it by name — set `disable-model-invocation: true`. Commands and skills are one mechanism; a command is just a manually-triggered skill.
3434
- **Use a hook when** the action is non-negotiable: format on every edit, block commits to `main`, log every tool call.
3535
- **Use MCP when** Claude needs to reach a system it can't touch with files and shell — but keep your MCP set **lean**, since each server adds context and surface area.
3636

@@ -49,7 +49,7 @@ Start on Sonnet. Step up to Opus when a task is genuinely hard; drop to Haiku wh
4949
- **`/clear`** between **unrelated** tasks — start each task with clean working memory.
5050
- **`/compact`** mid-task when context grows heavy but you still need continuity.
5151

52-
And one more reset worth memorizing: if you've **corrected Claude two or more times** on the same point, stop fighting the thread. Run `/clear` and **rewrite the prompt** from scratch — a clean start beats a confused one. (Why context hygiene matters: [./context-window.md](./context-window.md).)
52+
And one more reset worth memorizing: if you've **corrected Claude two or more times** on the same point, stop fighting the thread. Run `/clear` and **rewrite the prompt** from scratch — a clean start beats a confused one. (Why context hygiene matters: [the context window](./context-window.md).)
5353

5454
## At a glance
5555

@@ -59,4 +59,4 @@ And one more reset worth memorizing: if you've **corrected Claude two or more ti
5959
- Default to **Sonnet**; **Opus** for hard, **Haiku** for trivial.
6060
- New task → **/clear**. Long task filling up → **/compact**.
6161

62-
**Source:** https://code.claude.com/docs/en/overview
62+
**Source:** [Claude Code overview](https://code.claude.com/docs/en/overview)

docs/getting-started/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The native installer is recommended because it auto-updates in the background. P
2020
The native install drops a binary at `~/.local/bin/claude`. Make sure that directory is on your `PATH` if the `claude` command isn't found after installing.
2121

2222
> [!TIP]
23-
> On a fresh Mac, you can skip the manual steps entirely. See [../environment/bootstrap-setup.md](../environment/bootstrap-setup.md) for a one-command setup that installs everything at once.
23+
> On a fresh Mac, you can skip the manual steps entirely. See [the one-command setup](../environment/bootstrap-setup.md) for a one-command setup that installs everything at once.
2424
2525
## Platform notes
2626

@@ -57,6 +57,6 @@ claude doctor
5757
> [!NOTE]
5858
> If `claude` isn't recognized, open a new terminal so your shell picks up the updated `PATH`, then try `claude doctor` again.
5959
60-
Next: [./quickstart.md](./quickstart.md)
60+
Next: [Quickstart](./quickstart.md)
6161

62-
**Source:** https://code.claude.com/docs/en/setup
62+
**Source:** [Set up Claude Code](https://code.claude.com/docs/en/setup)

0 commit comments

Comments
 (0)