Skip to content

docs: comprehensive CLAUDE.md for AI assistants - #1

Draft
agentlab007 wants to merge 1 commit into
mainfrom
claude/claude-md-docs-EW05O
Draft

docs: comprehensive CLAUDE.md for AI assistants#1
agentlab007 wants to merge 1 commit into
mainfrom
claude/claude-md-docs-EW05O

Conversation

@agentlab007

Copy link
Copy Markdown
Owner

Summary

Replaces the one-line CLAUDE.md (which only pointed to AGENTS.md) with a comprehensive guide for AI assistants working in this repo.

What's in the new CLAUDE.md

  • Project purpose — FastAPI proxy translating Anthropic Messages API ↔ OpenAI-compatible providers (NVIDIA NIM, OpenRouter, DeepSeek, LM Studio, llama.cpp), plus the Discord/Telegram bot.
  • Repository layout — annotated tree of api/, providers/ (+common/), messaging/, config/, cli/, tests/.
  • Request flow — auth → local optimization short-circuits → model resolution → provider streaming → Anthropic SSE.
  • Dev workflow — the required ordered checks (ruff format, ruff check, ty check, pytest) enforced by .github/workflows/tests.yml, plus the # type: ignore ban.
  • Conventions & extension points — shared-utility/DRY/encapsulation rules from AGENTS.md, how to add a provider or messaging platform, key env vars.

AGENTS.md

  • Corrected the stale "This file is identical to CLAUDE.md" note (it never was) to describe the two files' distinct-but-synced roles.

Verification

Docs-only change. Content cross-checked against pyproject.toml, .env.example, .github/workflows/tests.yml, the source tree, and the README's Development section.

https://claude.ai/code/session_01HEhV6gs82xriJ4UCPS5N8R


Generated by Claude Code

Replace the one-line CLAUDE.md pointer with full guidance covering project
purpose, repository layout, request flow, dev workflow and required CI checks,
extension points, key env vars, and AI-assistant conventions. Correct the stale
"identical" note in AGENTS.md to reflect the two files' distinct roles.

https://claude.ai/code/session_01HEhV6gs82xriJ4UCPS5N8R
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants