docs(guide): add YAML frontmatter to 24 top-level guide files
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Florian BRUNIAUX
parent
d1182af4cf
commit
ac9b07a837
24 changed files with 144 additions and 0 deletions
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Guide Documentation"
|
||||
description: "Index of all core documentation files for mastering Claude Code"
|
||||
tags: [guide, reference]
|
||||
---
|
||||
|
||||
# Guide Documentation
|
||||
|
||||
Core documentation for mastering Claude Code.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Choosing Your Adoption Approach"
|
||||
description: "Starting points for team adoption patterns and CLAUDE.md configuration strategies"
|
||||
tags: [guide, config, workflows]
|
||||
---
|
||||
|
||||
# Choosing Your Adoption Approach
|
||||
|
||||
> **Disclaimer**: Claude Code is young (~1 year). Nobody has definitive answers yet — including this guide. These are starting points based on observed patterns, not proven best practices. Adapt heavily to your context.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Agent Evaluation"
|
||||
description: "Metrics, patterns, and tools for measuring custom agent effectiveness"
|
||||
tags: [agents, testing, guide]
|
||||
---
|
||||
|
||||
# Agent Evaluation
|
||||
|
||||
**Quick nav**: [Why Evaluate?](#why-evaluate-agents) · [Metrics to Track](#metrics-to-track) · [Implementation](#implementation-patterns) · [Example](#example-agent-with-evaluation) · [Tools](#tools--references)
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "AI Ecosystem: Maximizing Claude Code with Complementary Tools"
|
||||
description: "When to use Claude Code vs complementary AI tools and how to chain them for optimal workflows"
|
||||
tags: [ai-ecosystem, guide, workflows, integration]
|
||||
---
|
||||
|
||||
# AI Ecosystem: Maximizing Claude Code with Complementary Tools
|
||||
|
||||
> **Reading time**: ~25 minutes
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "AI Code Traceability & Attribution"
|
||||
description: "Industry standards, tools, and templates for AI-generated code attribution policies"
|
||||
tags: [guide, git, workflows]
|
||||
---
|
||||
|
||||
# AI Code Traceability & Attribution
|
||||
|
||||
> **TL;DR**: As AI-generated code becomes ubiquitous, projects need clear attribution policies. This guide covers industry standards (LLVM, Ghostty, Fedora), practical tools (git-ai), and implementation templates.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "How Claude Code Works: Architecture & Internals"
|
||||
description: "Technical deep-dive into Claude Code internal mechanisms and architecture"
|
||||
tags: [architecture, guide, performance]
|
||||
---
|
||||
|
||||
# How Claude Code Works: Architecture & Internals
|
||||
|
||||
> A technical deep-dive into Claude Code's internal mechanisms, based on official Anthropic documentation and verified community analysis.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Claude Code Cheatsheet"
|
||||
description: "One-page printable daily essentials for maximum Claude Code productivity"
|
||||
tags: [cheatsheet, reference]
|
||||
---
|
||||
|
||||
# Claude Code Cheatsheet
|
||||
|
||||
**1 printable page** - Daily essentials for maximum productivity
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Claude Code Release History"
|
||||
description: "Condensed changelog of official Claude Code releases with highlights and breaking changes"
|
||||
tags: [reference, release]
|
||||
---
|
||||
|
||||
# Claude Code Release History
|
||||
|
||||
> Condensed changelog of Claude Code official releases.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Claude Cowork: Agentic Desktop for Knowledge Work"
|
||||
description: "Summary of Claude's agentic desktop feature for non-technical knowledge workers"
|
||||
tags: [guide, agents, workflows]
|
||||
---
|
||||
|
||||
# Claude Cowork: Agentic Desktop for Knowledge Work
|
||||
|
||||
> **📦 Complete documentation migrated to dedicated repository**
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Data Privacy & Retention Guide"
|
||||
description: "What data Claude Code sends to Anthropic servers and how to protect sensitive information"
|
||||
tags: [privacy, security, guide]
|
||||
---
|
||||
|
||||
# Data Privacy & Retention Guide
|
||||
|
||||
> **Critical**: Everything you share with Claude Code is sent to Anthropic servers. This guide explains what data leaves your machine and how to protect sensitive information.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "DevOps & SRE with Claude Code"
|
||||
description: "FIRE framework for infrastructure diagnosis and DevOps workflows with Claude Code"
|
||||
tags: [devops, guide, ci-cd, workflows]
|
||||
---
|
||||
|
||||
# DevOps & SRE with Claude Code
|
||||
|
||||
**Reading time**: 30 minutes
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Known Issues & Critical Bugs"
|
||||
description: "Verified critical issues affecting Claude Code users from community reports and official communications"
|
||||
tags: [reference, security, debugging]
|
||||
---
|
||||
|
||||
# Known Issues & Critical Bugs
|
||||
|
||||
This document tracks verified, critical issues affecting Claude Code users based on community reports and official communications.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Learning to Code with AI: The Conscious Developer's Guide"
|
||||
description: "Research-based guide for junior developers learning to code effectively with AI assistance"
|
||||
tags: [guide, workflows]
|
||||
---
|
||||
|
||||
# Learning to Code with AI: The Conscious Developer's Guide
|
||||
|
||||
> **Confidence**: Tier 2 — Based on academic research (2023-2025) and educator feedback
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "MCP Servers Ecosystem"
|
||||
description: "Validated community MCP servers evaluated for production readiness and security"
|
||||
tags: [mcp, reference, integration]
|
||||
---
|
||||
|
||||
# MCP Servers Ecosystem
|
||||
|
||||
**Last updated**: February 2026 • **Next review**: March 2026
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Development Methodologies Reference"
|
||||
description: "Quick reference for 15 structured AI-assisted development methodologies including TDD, SDD, and BDD"
|
||||
tags: [reference, tdd, design-patterns, workflows]
|
||||
---
|
||||
|
||||
# Development Methodologies Reference
|
||||
|
||||
> **Confidence**: Tier 2 — Validated by multiple production reports and official documentation.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Session Observability & Monitoring"
|
||||
description: "Track Claude Code usage, estimate costs, and identify patterns across development sessions"
|
||||
tags: [observability, guide, performance]
|
||||
---
|
||||
|
||||
# Session Observability & Monitoring
|
||||
|
||||
> Track Claude Code usage, estimate costs, and identify patterns across your development sessions.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Production Safety Rules"
|
||||
description: "Non-negotiable safety rules for teams deploying Claude Code in production environments"
|
||||
tags: [security, guide, devops]
|
||||
---
|
||||
|
||||
# Production Safety Rules
|
||||
|
||||
> **Audience**: Teams deploying Claude Code in production environments.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Sandbox Isolation for Coding Agents"
|
||||
description: "Running Claude Code safely in isolated environments with Docker, native sandbox, and cloud solutions"
|
||||
tags: [security, sandbox, devops, guide]
|
||||
---
|
||||
|
||||
# Sandbox Isolation for Coding Agents
|
||||
|
||||
> **Confidence**: Tier 2 — Official Docker docs + verified vendor documentation
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Native Sandboxing in Claude Code"
|
||||
description: "Understanding and configuring native process-level sandboxing in Claude Code"
|
||||
tags: [security, sandbox, guide]
|
||||
---
|
||||
|
||||
# Native Sandboxing in Claude Code
|
||||
|
||||
> **Confidence**: Tier 1 — Official Anthropic documentation
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Search Tools Cheatsheet"
|
||||
description: "Quick reference for choosing between rg, grepai, Serena and ast-grep"
|
||||
tags: [cheatsheet, search, reference]
|
||||
---
|
||||
|
||||
# Search Tools Cheatsheet (1-Page Reference)
|
||||
|
||||
> **Quick reference for choosing between rg, grepai, Serena & ast-grep**
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Security Hardening Guide"
|
||||
description: "Active threats, injection defense, and CVE-based security hardening for Claude Code"
|
||||
tags: [security, guide, hooks]
|
||||
---
|
||||
|
||||
# Security Hardening Guide
|
||||
|
||||
> **Confidence**: Tier 2 — Based on CVE disclosures, security research (2024-2026), and community validation
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Third-Party Tools for Claude Code"
|
||||
description: "Community tools for token tracking, session management, configuration, and alternative UIs"
|
||||
tags: [reference, integration, plugin]
|
||||
---
|
||||
|
||||
# Third-Party Tools for Claude Code
|
||||
|
||||
> Community tools for token tracking, session management, configuration, and alternative UIs.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "The Ultimate Claude Code Guide"
|
||||
description: "Comprehensive self-contained guide to mastering Claude Code from zero to power user"
|
||||
tags: [guide, reference, workflows, agents, hooks, mcp, security]
|
||||
---
|
||||
|
||||
# The Ultimate Claude Code Guide
|
||||
|
||||
> A comprehensive, self-contained guide to mastering Claude Code - from zero to power user.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "Claude Code — Visual Reference"
|
||||
description: "ASCII diagrams consolidating key Claude Code concepts in one visual overview"
|
||||
tags: [reference, architecture, cheatsheet]
|
||||
---
|
||||
|
||||
# Claude Code — Visual Reference
|
||||
|
||||
All diagrams in one place. Quick visual overview of Claude Code's key concepts.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue