chore: add llms.txt for AI indexation

Add structured summary file following llms.txt convention to help AI models (Claude, ChatGPT, Perplexity, etc.) better understand and index this repository. Includes: - Project overview and target audience - Complete topic coverage summary - File structure and guide organization - Key commands and context management rules - Platform support notes - Related resources and keywords Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 18:04:38 +01:00 · 2026-01-09 18:04:38 +01:00 · 4995480f22
commit 4995480f22
parent 68a3bdc8a6
1 changed files with 121 additions and 0 deletions
--- a/llms.txt
+++ b/llms.txt
@ -0,0 +1,121 @@
+# The Ultimate Claude Code Guide
+
+> A comprehensive, self-contained guide to mastering Claude Code - Anthropic's official CLI for AI-assisted development.
+
+## What This Repository Contains
+
+This repository provides everything needed to go from Claude Code beginner to power user:
+
+1. **Complete Guide** (`english-ultimate-claude-code-guide.md`) - 4700+ lines covering all aspects of Claude Code
+2. **Cheatsheet** (`cheatsheet-en.md`) - 1-page printable daily reference
+3. **Audit Prompt** (`claude-setup-audit-prompt.md`) - Self-contained prompt to analyze your Claude Code setup against best practices
+
+## Target Audience
+
+- **Beginners**: Installation, first workflow, essential commands (15 min to productivity)
+- **Intermediate**: Memory files, agents, skills, hooks configuration
+- **Power Users**: MCP servers, Trinity pattern, CI/CD integration, autonomous workflows
+
+## Key Topics Covered
+
+### Core Concepts
+- Context Management (the most critical concept - context windows, compaction, zones)
+- Plan Mode (safe read-only exploration before making changes)
+- Memory Files (CLAUDE.md for persistent context across sessions)
+- Rewind (undo mechanism for file changes)
+
+### Customization
+- **Agents**: Custom AI personas with specific tools and instructions
+- **Skills**: Reusable knowledge modules for complex domains
+- **Commands**: Custom slash commands for frequent workflows
+- **Hooks**: Event-driven automation (PreToolUse, PostToolUse, UserPromptSubmit)
+
+### Advanced Features
+- **MCP Servers**: Model Context Protocol for extended capabilities
+  - Serena (codebase indexation + session memory)
+  - Context7 (library documentation lookup)
+  - Sequential (structured multi-step reasoning)
+  - Playwright (browser automation)
+- **Trinity Pattern**: Combining Plan Mode + Think Levels + MCP for complex tasks
+- **CI/CD Integration**: Headless mode, GitHub Actions, Verify Gate pattern
+
+### Best Practices
+- Single Source of Truth pattern for conventions
+- Shell Scripts vs AI Agents decision framework
+- Tight feedback loops for rapid iteration
+- Continuous improvement mindset
+
+## File Structure
+
+```
+claude-code-ultimate-guide/
+├── README.md                           # Overview and quick start
+├── english-ultimate-claude-code-guide.md  # Complete guide (main content)
+├── cheatsheet-en.md                    # 1-page reference
+├── claude-setup-audit-prompt.md        # Setup audit tool
+├── llms.txt                            # This file (for AI indexation)
+└── *.pdf                               # Alternative formats
+```
+
+## Guide Structure (10 Sections)
+
+1. **Quick Start** - Installation, first workflow, essential commands
+2. **Core Concepts** - Context management, Plan Mode, Rewind, Mental Model
+3. **Memory & Settings** - CLAUDE.md files, .claude/ folder, precedence rules
+4. **Agents** - Custom AI personas, Tool SEO, orchestration patterns
+5. **Skills** - Reusable knowledge modules
+6. **Commands** - Custom slash commands, variable interpolation
+7. **Hooks** - Event-driven automation (security, formatting, logging)
+8. **MCP Servers** - Serena, Context7, Sequential, Playwright, Postgres
+9. **Advanced Patterns** - Trinity, CI/CD, feedback loops, vibe coding
+10. **Reference** - Commands, shortcuts, troubleshooting, checklists
+
+## Key Commands Reference
+
+| Command | Purpose |
+|---------|---------|
+| `/help` | Show all available commands |
+| `/status` | Check context usage and session state |
+| `/compact` | Compress context (use when >70%) |
+| `/clear` | Fresh start (reset conversation) |
+| `/plan` | Enter safe read-only planning mode |
+| `/rewind` | Undo recent changes |
+
+## Context Management Rules
+
+- **Green Zone (0-50%)**: Work freely
+- **Yellow Zone (50-70%)**: Be selective with context loading
+- **Red Zone (70-90%)**: Use `/compact` immediately
+- **Critical (90%+)**: Use `/clear` to reset
+
+## Platform Support
+
+- **macOS/Linux**: Full support with bash/zsh examples
+- **Windows**: PowerShell and batch file alternatives provided (note: Windows commands are AI-generated and not tested by the author)
+
+## Related Resources
+
+- Official: https://docs.anthropic.com/en/docs/claude-code
+- DeepWiki: https://deepwiki.com/FlorianBruniaux/claude-code-ultimate-guide
+- Inspiration: https://claudelog.com/
+
+## Author
+
+Florian BRUNIAUX - Founding Engineer at Méthode Aristote
+- GitHub: https://github.com/FlorianBruniaux
+- LinkedIn: https://www.linkedin.com/in/florian-bruniaux-43408b83/
+
+## License
+
+CC BY-SA 4.0 - Free to share and adapt with attribution.
+
+## How to Use This Guide
+
+1. **New to Claude Code?** Start with README.md Quick Start section
+2. **Want comprehensive learning?** Read english-ultimate-claude-code-guide.md
+3. **Need daily reference?** Print cheatsheet-en.md
+4. **Want to audit your setup?** Use claude-setup-audit-prompt.md
+
+## Keywords
+
+Claude Code, Anthropic, CLI, AI-assisted development, coding assistant, context management, MCP servers, agents, skills, hooks, commands, Plan Mode, CLAUDE.md, memory files, CI/CD integration, autonomous workflows, developer productivity, AI coding tools