From 54ae484e6753a5e5b15fbded9b60c95835f34631 Mon Sep 17 00:00:00 2001 From: Florian BRUNIAUX Date: Fri, 9 Jan 2026 16:18:23 +0100 Subject: [PATCH] docs: align terminology with official Anthropic documentation - Rename "Configuration" to "Memory & Settings" (section 3) - CLAUDE.md files are now properly called "Memory Files" - Add explanatory note about why they're called "memory" - Update all internal references (diagrams, headings, precedence rules) - Add table of contents with direct links to README - Add GitHub stars badge and call-to-action - Update cheatsheet with consistent terminology Based on feedback that configuration should refer to settings.json, while CLAUDE.md files are officially called "memory" in Anthropic docs. Co-Authored-By: Claude Opus 4.5 --- README.md | 82 +++++++++------------------ cheatsheet-en.md | 14 ++--- english-ultimate-claude-code-guide.md | 26 ++++----- 3 files changed, 47 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 2ea37ff..a1e788b 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ > From zero to power user — a comprehensive, self-contained guide to mastering Claude Code. [![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-sa/4.0/) +[![GitHub stars](https://img.shields.io/github/stars/FlorianBruniaux/claude-code-ultimate-guide?style=social)](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/stargazers) **Author**: [Florian BRUNIAUX](https://github.com/FlorianBruniaux) | Founding Engineer [@Méthode Aristote](https://methode-aristote.fr) @@ -10,6 +11,8 @@ **Written with**: Claude (Anthropic) +> **If you find this guide useful, please consider giving it a star!** It helps others discover this resource and motivates continued updates. + --- ## About This Guide @@ -37,68 +40,37 @@ If you find value in this guide, have questions, or want to discuss Claude Code --- -## Guide Overview +## Table of Contents -### 1. Quick Start (Day 1) -Installation, first workflow, essential commands, permission modes. +Jump directly to any section in the [full guide](./english-ultimate-claude-code-guide.md): -### 2. Core Concepts -- **Context Management** — The most critical concept (zones, recovery, poisoning) -- **Plan Mode** — Safe exploration before changes -- **Rewind** — Undo mistakes safely -- **Mental Model** — How Claude sees your codebase +| # | Section | Description | +|---|---------|-------------| +| 1 | [Quick Start](./english-ultimate-claude-code-guide.md#1-quick-start-day-1) | Installation, first workflow, essential commands | +| 2 | [Core Concepts](./english-ultimate-claude-code-guide.md#2-core-concepts) | Context management, Plan Mode, Rewind, Mental Model | +| 3 | [Memory & Settings](./english-ultimate-claude-code-guide.md#3-memory--settings) | CLAUDE.md files, .claude/ folder, precedence rules | +| 4 | [Agents](./english-ultimate-claude-code-guide.md#4-agents) | Custom AI personas, Tool SEO, orchestration patterns | +| 5 | [Skills](./english-ultimate-claude-code-guide.md#5-skills) | Reusable knowledge modules (Security, TDD...) | +| 6 | [Commands](./english-ultimate-claude-code-guide.md#6-commands) | Custom slash commands, variable interpolation | +| 7 | [Hooks](./english-ultimate-claude-code-guide.md#7-hooks) | Event-driven automation (security, formatting, logging) | +| 8 | [MCP Servers](./english-ultimate-claude-code-guide.md#8-mcp-servers) | Serena, Context7, Sequential, Playwright, Postgres | +| 9 | [Advanced Patterns](./english-ultimate-claude-code-guide.md#9-advanced-patterns) | Trinity, CI/CD, feedback loops, vibe coding | +| 10 | [Reference](./english-ultimate-claude-code-guide.md#10-reference) | Commands, shortcuts, troubleshooting, checklists | +| A | [Appendix](./english-ultimate-claude-code-guide.md#appendix-templates-collection) | Ready-to-use templates | -### 3. Configuration -- `CLAUDE.md` files (global, project, local) -- The `.claude/` folder structure -- Settings & permissions -- Precedence rules +### Quick Links by Topic -### 4. Agents -Create specialized AI personas for specific tasks: -- Code reviewer, debugger, backend architect -- Tool SEO for better agent discovery -- Multi-agent orchestration patterns +**Getting Started** +- [Installation](./english-ultimate-claude-code-guide.md#11-installation) · [First Workflow](./english-ultimate-claude-code-guide.md#12-first-workflow) · [Essential Commands](./english-ultimate-claude-code-guide.md#13-essential-commands) -### 5. Skills -Reusable knowledge modules: -- Security Guardian (OWASP, secrets management) -- TDD (Red-Green-Refactor cycle) -- Creating your own skills +**Critical Concepts** +- [Context Management](./english-ultimate-claude-code-guide.md#22-context-management) · [Plan Mode](./english-ultimate-claude-code-guide.md#23-plan-mode) · [Memory Files](./english-ultimate-claude-code-guide.md#31-memory-files-claudemd) -### 6. Commands -Custom slash commands: -- `/commit`, `/pr`, problem framer -- Variable interpolation with `$ARGUMENTS` +**Customization** +- [Creating Agents](./english-ultimate-claude-code-guide.md#42-creating-custom-agents) · [Creating Skills](./english-ultimate-claude-code-guide.md#52-creating-skills) · [Creating Commands](./english-ultimate-claude-code-guide.md#62-creating-custom-commands) · [Creating Hooks](./english-ultimate-claude-code-guide.md#72-creating-hooks) -### 7. Hooks -Event-driven automation: -- Security blockers (pre-tool use) -- Auto-formatters (post-tool use) -- Context enrichers (prompt submit) -- Activity logging - -### 8. MCP Servers -External tool integrations: -- **Serena** — Semantic code navigation -- **Context7** — Library documentation -- **Sequential** — Structured reasoning -- **Playwright** — Browser automation -- **Postgres** — Database queries - -### 9. Advanced Patterns -- The Trinity (Plan + Think + Agents) -- CI/CD & IDE integration -- Tight feedback loops -- Todo as instruction mirrors -- Vibe coding & skeleton projects -- Batch operations - -### 10. Reference -Commands table, keyboard shortcuts, troubleshooting, checklists. - -### Appendix -Ready-to-use templates for agents, skills, commands, hooks, settings, and prompts. +**Advanced** +- [The Trinity Pattern](./english-ultimate-claude-code-guide.md#91-the-trinity) · [CI/CD Integration](./english-ultimate-claude-code-guide.md#93-cicd-integration) · [MCP Configuration](./english-ultimate-claude-code-guide.md#83-configuration) --- diff --git a/cheatsheet-en.md b/cheatsheet-en.md index 697e6e6..cd4163d 100644 --- a/cheatsheet-en.md +++ b/cheatsheet-en.md @@ -61,7 +61,7 @@ --- -## Configuration (2 levels) +## Memory & Settings (2 levels) | Level | Location | Scope | Git | |-------|----------|-------|-----| @@ -72,10 +72,10 @@ | File | Where | Usage | |------|-------|-------| -| `CLAUDE.md` | Project root | Team instructions | -| `settings.json` | `.claude/` | Team permissions | -| `settings.local.json` | `.claude/` | Your overrides | -| `CLAUDE.md` | `~/.claude/` | Personal instructions | +| `CLAUDE.md` | Project root | Team memory (instructions) | +| `settings.json` | `.claude/` | Team settings (hooks) | +| `settings.local.json` | `.claude/` | Your setting overrides | +| `CLAUDE.md` | `~/.claude/` | Personal memory | --- @@ -83,7 +83,7 @@ ``` .claude/ -├── CLAUDE.md # Personal instructions +├── CLAUDE.md # Local memory (gitignored) ├── settings.json # Hooks (committed) ├── settings.local.json # Permissions (not committed) ├── agents/ # Custom agents @@ -289,7 +289,7 @@ Deep analysis → Use --think or --ultrathink - **Official docs**: [docs.anthropic.com/claude-code](https://docs.anthropic.com/en/docs/claude-code) - **Inspired by**: [Claudelog.com](https://claudelog.com/) - Advanced tips & patterns - **Full guide**: `english-ultimate-claude-code-guide.md` -- **Project config**: `CLAUDE.md` at project root +- **Project memory**: `CLAUDE.md` at project root --- diff --git a/english-ultimate-claude-code-guide.md b/english-ultimate-claude-code-guide.md index f43d35a..a68bc5d 100644 --- a/english-ultimate-claude-code-guide.md +++ b/english-ultimate-claude-code-guide.md @@ -42,7 +42,7 @@ Describe → Claude Analyzes → Review Diff → Accept/Reject → Verify | 70-90% | `/compact` now | | 90%+ | `/clear` required | -### Configuration Priority +### Memory Hierarchy ``` ~/.claude/CLAUDE.md → Global (all projects) /project/CLAUDE.md → Project (committed) @@ -91,9 +91,9 @@ Context full → /compact or /clear - [2.3 Plan Mode](#23-plan-mode) - [2.4 Rewind](#24-rewind) - [2.5 Mental Model](#25-mental-model) -- [3. Configuration](#3-configuration) - - [3.1 CLAUDE.md Files](#31-claudemd-files) - - [3.2 The .claude/ Folder](#32-the-claude-folder) +- [3. Memory & Settings](#3-memory--settings) + - [3.1 Memory Files (CLAUDE.md)](#31-memory-files-claudemd) + - [3.2 The .claude/ Folder Structure](#32-the-claude-folder-structure) - [3.3 Settings & Permissions](#33-settings--permissions) - [3.4 Precedence Rules](#34-precedence-rules) - [4. Agents](#4-agents) @@ -756,21 +756,21 @@ The more context you provide, the better Claude can help. --- -# 3. Configuration +# 3. Memory & Settings **Reading time**: 15 minutes **Skill level**: Week 1 **Goal**: Customize Claude Code for your project -## 3.1 CLAUDE.md Files +## 3.1 Memory Files (CLAUDE.md) -CLAUDE.md files are persistent instructions that Claude reads at the start of every session. +CLAUDE.md files are persistent instructions that Claude reads at the start of every session. They're called "memory" files because they give Claude long-term memory of your preferences, conventions, and project context — persisting across sessions rather than being forgotten after each conversation. -### Three Levels of Configuration +### Three Levels of Memory ``` ┌─────────────────────────────────────────────────────────┐ -│ CONFIGURATION HIERARCHY │ +│ MEMORY HIERARCHY │ ├─────────────────────────────────────────────────────────┤ │ │ │ ~/.claude/CLAUDE.md (Global - All projects) │ @@ -859,9 +859,9 @@ Personal overrides not committed to git (add to .gitignore): | Update when conventions change | Let it go stale | | Reference external docs | Duplicate documentation | -## 3.2 The .claude/ Folder +## 3.2 The .claude/ Folder Structure -The `.claude/` folder is your project's Claude Code configuration directory. +The `.claude/` folder is your project's Claude Code directory for memory, settings, and extensions. ### Full Structure @@ -1134,9 +1134,9 @@ claude ## 3.4 Precedence Rules -When configurations conflict, Claude Code uses this precedence: +When memory files or settings conflict, Claude Code uses this precedence: -### Configuration Precedence +### Settings Precedence ``` Highest Priority