[PR #5094] [CLOSED] Add CLAUDE.md with codebase guidance for Claude Code #5298

Closed
opened 2026-06-05 15:20:53 -04:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/Mintplex-Labs/anything-llm/pull/5094
Author: @xinxin6623
Created: 3/1/2026
Status: Closed

Base: masterHead: master


📝 Commits (2)

  • e06cb16 Add CLAUDE.md with codebase guidance for Claude Code
  • abe5616 Expand CLAUDE.md with full architecture deep dive

📊 Changes

1 file changed (+245 additions, -0 deletions)

View changed files

CLAUDE.md (+245 -0)

📄 Description

Summary

Adds a CLAUDE.md file to help Claude Code quickly understand this repository when starting a new session.

The file documents:

  • Common commands — dev server startup, build, lint, test, and all Prisma database commands (including how to run a single test file)
  • Three-service architecture — Server (Express, port 3001), Frontend (React+Vite, port 3000), Collector (document processor, port 8888), with ports, roles, and key subdirectory map for each
  • Server internals — LLM/vector DB/embedding provider factory pattern, full chat pipeline step-by-step (vector search → context assembly → token budgeting → streaming), key Prisma data models
  • Frontend internals — routing structure, context providers, API communication layer pattern, key hooks
  • Collector internals — supported file formats and handlers, parse vs process modes, document output format, link/URL processing
  • Key design patterns — workspace-as-namespace, chat vs query mode, pinned documents, token budgeting, source attribution

Test plan

  • Verify all commands listed are accurate against current package.json scripts
  • Confirm architecture descriptions match the codebase

🤖 Generated with Claude Code


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/Mintplex-Labs/anything-llm/pull/5094 **Author:** [@xinxin6623](https://github.com/xinxin6623) **Created:** 3/1/2026 **Status:** ❌ Closed **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (2) - [`e06cb16`](https://github.com/Mintplex-Labs/anything-llm/commit/e06cb1661a0ceb4287a1668c2182927041db5616) Add CLAUDE.md with codebase guidance for Claude Code - [`abe5616`](https://github.com/Mintplex-Labs/anything-llm/commit/abe5616d1b6a22d0f03441775d918a4434320de2) Expand CLAUDE.md with full architecture deep dive ### 📊 Changes **1 file changed** (+245 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `CLAUDE.md` (+245 -0) </details> ### 📄 Description ## Summary Adds a `CLAUDE.md` file to help [Claude Code](https://claude.ai/code) quickly understand this repository when starting a new session. The file documents: - **Common commands** — dev server startup, build, lint, test, and all Prisma database commands (including how to run a single test file) - **Three-service architecture** — Server (Express, port 3001), Frontend (React+Vite, port 3000), Collector (document processor, port 8888), with ports, roles, and key subdirectory map for each - **Server internals** — LLM/vector DB/embedding provider factory pattern, full chat pipeline step-by-step (vector search → context assembly → token budgeting → streaming), key Prisma data models - **Frontend internals** — routing structure, context providers, API communication layer pattern, key hooks - **Collector internals** — supported file formats and handlers, parse vs process modes, document output format, link/URL processing - **Key design patterns** — workspace-as-namespace, chat vs query mode, pinned documents, token budgeting, source attribution ## Test plan - [ ] Verify all commands listed are accurate against current `package.json` scripts - [ ] Confirm architecture descriptions match the codebase 🤖 Generated with [Claude Code](https://claude.ai/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-05 15:20:53 -04:00
yindo closed this issue 2026-06-05 15:20:53 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Mintplex-Labs/anything-llm#5298