CLAUDE.md examples from real projects

ForeactLabsReads credentialsCLAUDE.md

OpenExecutive

ForeactLabs/OpenExecutive/CLAUDE.md

also gitignored. Structure: - `company/profile.yaml` — structured company profile (populated by onboarding wizard) - `company/docs/` — uploaded documents (indexed into ChromaDB) ## Code Style - Python: `ruff` for linting, `mypy` for type checking, `pytest` for tests

shader-slangCLAUDE.md

slang

shader-slang/slang/CLAUDE.md

access by role/key, not by position. - **Keep a working log/report.** Maintain a scratch markdown document throughout the task that records: the problem and a motivating example, road-blockers encountered

shader-slangCLAUDE.md

slang / extras

shader-slang/slang/extras/claude.md

reviewer: checks correctness, style, edge cases, test coverage, and regressions. It also reviews all documentation changes and reverts additions that are not significant enough to justify a permanent change

coleam00CLAUDE.md

ottomator-agents / agentic-rag-knowledge-graph

coleam00/ottomator-agents/agentic-rag-knowledge-graph/CLAUDE.md

python commands with 'python3' ### 🔌 MCP Server Usage #### Crawl4AI RAG MCP Server - **Use for external documentation**: Get docs for Pydantic AI - **Always check available sources first**: Use `get_available_sources

coleam00CLAUDE.md

ottomator-agents / claude-agent-sdk-demos

coleam00/ottomator-agents/claude-agent-sdk-demos/CLAUDE.md

NEVER code without checking current tasks first.** ## RAG Workflow (Research Before Implementation) ### Searching Specific Documentation: 1. **Get sources** → `rag_get_available_sources()` - Returns list with id, title, url 2. **Find

coleam00CLAUDE.md

ottomator-agents / claude-skill-archon

coleam00/ottomator-agents/claude-skill-archon/CLAUDE.md

available across all projects ## Repository Structure ``` claude_code_skills/ ├── README.md # Complete workshop guide and documentation ├── .claude/ │ ├── skills/ │ │ └── archon/ # Example skill: Archon integration │ │ ├── SKILL.md # Main skill definition with YAML frontmatter │ │ ├── scripts

coleam00Reads credentialsCLAUDE.md

ottomator-agents / livekit-agent

coleam00/ottomator-agents/livekit-agent/CLAUDE.md

mode=auto` - **Mock external services** in unit tests - **Use behavioral testing** for conversation flows ## 📚 Documentation Structure When documenting agents: 1. **Purpose**: What the agent does 2. **Configuration**: Required environment variables

VercelCLAUDE.md

streamdown / website

vercel/streamdown/apps/website/.claude/CLAUDE.md

boundary conditions and error states 5. **User experience** - Accessibility, performance, and usability considerations 6. **Documentation** - Add comments for complex logic, but prefer self-documenting code --- Most formatting and common issues

No other project uses it yet

steveruizokCLAUDE.md

perfect-freehand

steveruizok/perfect-freehand/CLAUDE.md

with Prettier yarn format # Check formatting without making changes yarn format:check # Generate API documentation cd packages/perfect-freehand && yarn docs ``` ## Architecture This is a **yarn workspaces monorepo** with two packages: - `packages/perfect-freehand

No other project uses it yet

nyblnetCLAUDE.md

bento

nyblnet/bento/CLAUDE.md

Bento — self-contained office documents One HTML file = the document + viewer + editor. See `README.md` for the vision. `slides/` is the first app (PowerPoint replacement); **Bento Spaces** (Notion/notes-like) and **Bento Dash

No other project uses it yet

nyblnetCLAUDE.md

bento / slides

nyblnet/bento/slides/CLAUDE.md

anim, charts, i18n, sync), shared by every app. ## Architecture (slides/) - `src/model.ts` — the `bento/slides` JSON document model. This is the format. - `src/starterdeck.ts` — the showcase starter deck (what a fresh build opens

No other project uses it yet

umputunCLAUDE.md

remark42

umputun/remark42/CLAUDE.md

with a type and an area (add priority when relevant): - Type: `bug`, `enhancement`, `question`, `documentation`, `discussion` - Area: `backend`, `frontend`, `site`, `CI`, `design`, `localization` - Priority: `important`, `minor`, `some day` - Contribution: `help

umputunCLAUDE.md

remark42 / frontend

umputun/remark42/frontend/CLAUDE.md

those patch floors into `engines` or the docs, or every lockfile refresh becomes a documentation change. ## One manifest, at `frontend/apps/remark42` `frontend/` holds no `package.json`, no lockfile and no `pnpm-workspace.yaml`. Everything

zenml-ioCLAUDE.md

zenml

zenml-io/zenml/CLAUDE.md

ZenML Claude Code Guidelines This document provides guidance for Claude Code when working with the ZenML codebase. ZenML is an extensible, open-source MLOps framework for creating production-ready

zenml-ioReads credentialsCLAUDE.md

zenml

zenml-io/zenml/.github/CLAUDE.md

ZenML GitHub Actions Guidelines This document provides guidance for AI assistants working with ZenML's GitHub Actions workflows. ## Workflow Organization ### Categories | Category | Workflows | Purpose | |----------|-----------|---------| | **CI/Testing** | ci-fast.yml, ci-slow.yml, unit-test.yml, integration-test

phanCLAUDE.md

phan

phan/phan/CLAUDE.md

issue emission in appropriate visitor 3. Add test cases in `tests/files/` 4. Update documentation ### Creating a Plugin 1. Create plugin in `.phan/plugins/` 2. Extend `\Phan\PluginV3` 3. Implement required visitor

No other project uses it yet

orion-libCLAUDE.md

OrionTV

orion-lib/OrionTV/CLAUDE.md

ALWAYS prefer editing an existing file to creating a new one. NEVER proactively create documentation files (\*.md) or README files. Only create documentation files if explicitly requested by the User

useplunkReads credentialsCLAUDE.md

plunk

useplunk/plunk/CLAUDE.md

Main platform (next-app.useplunk.com) - **landing**: Next.js app (Pages Router) - Marketing site (www.useplunk.com) - **wiki**: Next.js app - Documentation site (docs.useplunk.com) ### Background Job Architecture The API uses BullMQ (backed by Redis) for asynchronous

0xebCLAUDE.md

TheBigPromptLibrary

0xeb/TheBigPromptLibrary/.claude/CLAUDE.md

custom GPT instructions, jailbreak prompts, and instruction protection techniques. The content is primarily markdown documentation for educational purposes around prompt engineering and LLM security research. ## Repository Structure - **SystemPrompts/** - System prompts

prettierCLAUDE.md

prettier-vscode

prettier/prettier-vscode/CLAUDE.md

ModuleResolver`, `PrettierEditService`, and `StatusBar` - Registers formatting commands and disposables **PrettierEditService** (`src/PrettierEditService.ts`): - Registers VS Code document formatting providers - Handles format document/selection requests - Watches for config file changes (`.prettierrc`, `package.json`, etc.) - Builds