diff --git a/CHANGELOG.md b/CHANGELOG.md index 22eaa4f..e63c7b9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,37 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ## [Unreleased] +## [3.1.0] - 2026-01-13 + +### Changed +- **Major repository restructuring** - Reorganized 15 root files into 4 thematic directories + - `guide/` - Core documentation (ultimate-guide.md, cheatsheet.md, adoption-approaches.md) + - `tools/` - Interactive utilities (audit-prompt.md, onboarding-prompt.md, mobile-access.md) + - `machine-readable/` - LLM/AI consumption (reference.yaml, llms.txt) + - `exports/` - Generated outputs (notebooklm.pdf, kimi.pdf) +- **File renaming** for cleaner paths: + - `english-ultimate-claude-code-guide.md` → `guide/ultimate-guide.md` + - `cheatsheet-en.md` → `guide/cheatsheet.md` + - `claude-setup-audit-prompt.md` → `tools/audit-prompt.md` + - `personalized-onboarding-prompt.md` → `tools/onboarding-prompt.md` + - `mobile-access-setup.md` → `tools/mobile-access.md` + - `claude-code-reference.yaml` → `machine-readable/reference.yaml` +- **README.md** - Added "Repository Structure" section with visual tree +- **150+ internal links updated** across all documentation files +- **Deleted** empty `to-ignore/` directory + +### Added +- `guide/README.md` - Index for core documentation folder +- `tools/README.md` - Index for interactive utilities folder +- `machine-readable/README.md` - Index for LLM consumption folder +- `exports/README.md` - Index for generated outputs folder + +### Stats +- 10 files moved to new locations +- 4 new README.md files created +- 150+ links updated +- Navigation significantly improved + ## [3.0.7] - 2026-01-13 ### Added diff --git a/README.md b/README.md index 2c06e47..f2b1a00 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,6 @@ [](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/stargazers) [](https://zread.ai/FlorianBruniaux/claude-code-ultimate-guide) -```bash -npm install -g @anthropic-ai/claude-code && claude -``` - --- **Transparency note**: This guide reflects my personal experience after several months of daily Claude Code usage. I'm sharing what I've learned, not claiming expertise. The tool evolves constantly, and so does my understanding. [Feedback welcome](./CONTRIBUTING.md). @@ -15,11 +11,11 @@ npm install -g @anthropic-ai/claude-code && claude --- **Start here:** -- [Cheat Sheet](./cheatsheet-en.md) — print this, start coding -- [15-min Quick Start](./english-ultimate-claude-code-guide.md#1-quick-start-day-1) — first workflow +- [Cheat Sheet](./guide/cheatsheet.md) — print this, start coding +- [15-min Quick Start](./guide/ultimate-guide.md#1-quick-start-day-1) — first workflow - [Audit your setup](./examples/scripts/audit-scan.sh) — quick scan -**Go deeper** (optional): [Learning paths by role](#-by-role-tailored-learning-paths) | [Full guide](./english-ultimate-claude-code-guide.md) +**Go deeper** (optional): [Learning paths by role](#-by-role-tailored-learning-paths) | [Full guide](./guide/ultimate-guide.md) --- @@ -46,9 +42,8 @@ npm install -g @anthropic-ai/claude-code && claude ### Prerequisites -- **Node.js 18+** (or use the [shell installer](./english-ultimate-claude-code-guide.md#11-installation) on macOS/Linux) +- **Node.js 18+** (or use the [shell installer](./guide/ultimate-guide.md#11-installation) on macOS/Linux) - **Anthropic API key** — [Get one here](https://console.anthropic.com/) -- **~$5-20/month** typical usage cost (varies with usage intensity) --- @@ -58,19 +53,19 @@ npm install -g @anthropic-ai/claude-code && claude | If you... | Start here | Depth | |-----------|------------|-------| -| Just installed Claude Code | [Quick Start](#-quick-start-15-minutes) | Essentials | +| Just installed Claude Code | [Quick Start](./guide/ultimate-guide.md#1-quick-start-day-1) | Essentials | | Want to understand core concepts | [Junior Path](#-by-role-tailored-learning-paths) | Foundation | | Already use AI coding tools | [Senior Path](#-by-role-tailored-learning-paths) | Intermediate | | Need to configure a team setup | [Power User Path](#-by-role-tailored-learning-paths) | Comprehensive | | Need to evaluate/approve adoption | [PM Path](#-by-role-tailored-learning-paths) | Overview | -| Choosing turnkey vs. autonomous approach | [Adoption Guide](./adoption-approaches.md) | Quick read | +| Choosing turnkey vs. autonomous approach | [Adoption Guide](./guide/adoption-approaches.md) | Quick read | | Want to check your current setup | [Audit Your Setup](#-audit-your-setup) | Quick scan | | Want AI assistants to know Claude Code | [LLM Reference](#-llm-reference) | Reference | | Want personalized recommendations | [Deep Audit](#-deep-audit-personalized-recommendations) | Quick scan | | Want to test your knowledge | [Knowledge Quiz](#-knowledge-quiz) | Interactive | -| Want a guided tour | [Personalized Onboarding](./personalized-onboarding-prompt.md) | Interactive | +| Want a guided tour | [Personalized Onboarding](./tools/onboarding-prompt.md) | Interactive | | Having issues with Claude Code | [/diagnose command](./examples/commands/diagnose.md) | Quick fix | -| Want mobile access to Claude Code | [Mobile Access Setup](./mobile-access-setup.md) | WIP | +| Want mobile access to Claude Code | [Mobile Access Setup](./tools/mobile-access.md) | WIP | ### ⚡ Audit Your Setup @@ -82,19 +77,19 @@ curl -sL https://raw.githubusercontent.com/FlorianBruniaux/claude-code-ultimate- **Instant checks**: Config files, tech stack, extensions, security hooks, MCP servers, CLAUDE.md quality -**Want deeper analysis?** Use [`claude-setup-audit-prompt.md`](./claude-setup-audit-prompt.md) for personalized recommendations (~3 min). +**Want deeper analysis?** Use [`tools/audit-prompt.md`](./tools/audit-prompt.md) for personalized recommendations (~3 min). ### 🤖 LLM Reference Give any AI assistant instant Claude Code expertise (~2K tokens): ```bash -curl -sL https://raw.githubusercontent.com/FlorianBruniaux/claude-code-ultimate-guide/main/claude-code-reference.yaml +curl -sL https://raw.githubusercontent.com/FlorianBruniaux/claude-code-ultimate-guide/main/machine-readable/reference.yaml ``` -**Use cases**: Paste output into ChatGPT/Claude/Gemini, add to system prompts, or reference in Claude Code with `@claude-code-reference.yaml` +**Use cases**: Paste output into ChatGPT/Claude/Gemini, add to system prompts, or reference in Claude Code with `@machine-readable/reference.yaml` -**What's inside**: Decision trees, command reference, context zones, MCP servers, agent templates, troubleshooting—optimized for machine consumption. Points to line numbers in the [full guide](./english-ultimate-claude-code-guide.md) for deep dives. +**What's inside**: Decision trees, command reference, context zones, MCP servers, agent templates, troubleshooting—optimized for machine consumption. Points to line numbers in the [full guide](./guide/ultimate-guide.md) for deep dives. ### 🔬 Deep Audit (Personalized Recommendations) @@ -111,7 +106,7 @@ curl -sL https://raw.githubusercontent.com/FlorianBruniaux/claude-code-ultimate- ```bash # Claude Code Deep Audit - Context-Aware Version # Downloads reference files, reads YOUR local files, analyzes with Claude -REF=$(curl -sL https://raw.githubusercontent.com/FlorianBruniaux/claude-code-ultimate-guide/main/claude-code-reference.yaml) +REF=$(curl -sL https://raw.githubusercontent.com/FlorianBruniaux/claude-code-ultimate-guide/main/machine-readable/reference.yaml) SCAN=$(curl -sL https://raw.githubusercontent.com/FlorianBruniaux/claude-code-ultimate-guide/main/examples/scripts/audit-scan.sh | bash -s -- --json 2>/dev/null) README_CONTENT=$(head -100 README.md 2>/dev/null || echo "No README.md found") CLAUDE_MD=$(cat CLAUDE.md 2>/dev/null || echo "No CLAUDE.md found") @@ -151,7 +146,7 @@ Based on ALL this context, provide: - Domain-aware suggestions (e.g., EdTech → session planning agents, E-commerce → inventory commands) - Non-duplicate suggestions: Only recommends agents/commands you don't already have -**Want maximum depth?** Use [claude-setup-audit-prompt.md](./claude-setup-audit-prompt.md) with `claude --ultrathink` +**Want maximum depth?** Use [tools/audit-prompt.md](./tools/audit-prompt.md) with `claude --ultrathink` ### 🧠 Knowledge Quiz @@ -208,7 +203,7 @@ Explanation: Exit code 2 blocks the operation. Exit code 0 allows it to proceed. Other exit codes are treated as errors and logged but don't block. -See: english-ultimate-claude-code-guide.md#72-creating-hooks +See: guide/ultimate-guide.md#72-creating-hooks ------------------------------------------------------------ QUIZ COMPLETE @@ -248,22 +243,22 @@ Weak Areas (< 75%): **Junior Developer** (Foundation path) -1. [Quick Start](./english-ultimate-claude-code-guide.md#1-quick-start-day-1) — Install & first workflow -2. [Essential Commands](./english-ultimate-claude-code-guide.md#13-essential-commands) — The 7 commands -3. [Context Management](./english-ultimate-claude-code-guide.md#22-context-management) — Critical concept -4. [Memory Files](./english-ultimate-claude-code-guide.md#31-memory-files-claudemd) — Your first CLAUDE.md -5. [Cheat Sheet](./cheatsheet-en.md) — Print this +1. [Quick Start](./guide/ultimate-guide.md#1-quick-start-day-1) — Install & first workflow +2. [Essential Commands](./guide/ultimate-guide.md#13-essential-commands) — The 7 commands +3. [Context Management](./guide/ultimate-guide.md#22-context-management) — Critical concept +4. [Memory Files](./guide/ultimate-guide.md#31-memory-files-claudemd) — Your first CLAUDE.md +5. [Cheat Sheet](./guide/cheatsheet.md) — Print this