Skip to content

docs: add CLAUDE.md#9

Merged
mrjunos merged 1 commit into
mainfrom
docs/add-claude-md
Apr 8, 2026
Merged

docs: add CLAUDE.md#9
mrjunos merged 1 commit into
mainfrom
docs/add-claude-md

Conversation

@mrjunos

@mrjunos mrjunos commented Apr 8, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds CLAUDE.md to the repo root with a comprehensive guide for AI assistants and new contributors
  • Covers: architecture, PageIndex integration quirks, testing/mocking conventions, key rules, known debt, demo dataset

What's in it

  • Request flow diagram for POST /chat
  • PageIndex submodule path hack and doc_name without extension detail
  • Mocking strategy: 6 fixtures in conftest.py, mock-at-usage-site rule
  • Convention rules: SUPPORTED_EXTENSIONS, adding endpoints, DB schema changes, LLM calls
  • Known debt from audit-001 (cross-referenced)

Test plan

  • No code changes — documentation only
  • CI passes (no tests affected)

🤖 Generated with Claude Code

Covers PageIndex integration details, mocking strategy, testing conventions,
known debt, and contribution rules — so any AI assistant (or new dev) can
work on the repo without re-deriving context from scratch.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@mrjunos
mrjunos merged commit 75ef44d into main Apr 8, 2026
1 check passed
@mrjunos
mrjunos deleted the docs/add-claude-md branch April 8, 2026 01:04
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.

1 participant