mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-11-10 13:24:05 +08:00
chore: update stale CLAUDE.md references after the AGENTS.md rename (#19990)
This commit is contained in:
1 parent
18ebd2611d
commit
b3dd27c291
6 files changed
+8
-8
No files matched your search
@@ -1,6 +1,6 @@
|
||||
# RAGFlow Instructions
|
||||
|
||||
Use this file as the local operating guide for the current codebase. Prefer the code and the current CLAUDE.md over any older convention or remembered project shape.
|
||||
Use this file as the local operating guide for the current codebase. Prefer the code and the current AGENTS.md over any older convention or remembered project shape.
|
||||
|
||||
## Core Stance
|
||||
- Treat legacy code as liability, not as a compatibility target.
|
||||
@@ -12,7 +12,7 @@ Use this file as the local operating guide for the current codebase. Prefer the
|
||||
|
||||
## Current stack
|
||||
- Backend: Python 3.13+, Quart-based API server, Peewee ORM, async workers.
|
||||
- Frontend: React + TypeScript + Vite in `web/`. When working under `web/`, read and follow `web/CLAUDE.md` — it holds the frontend conventions (dual-backend Go/Python variants, test placement, styling, data fetching).
|
||||
- Frontend: React + TypeScript + Vite in `web/`. When working under `web/`, read and follow `web/AGENTS.md` — it holds the frontend conventions (dual-backend Go/Python variants, test placement, styling, data fetching).
|
||||
- Go: the repository also has a substantial Go module for servers, ingestion, parser/runtime, CLI, and supporting services.
|
||||
- Runtime services commonly include MySQL/PostgreSQL, Redis, MinIO, and Elasticsearch/Infinity/OpenSearch depending on configuration.
|
||||
|
||||
|
||||
@@ -328,7 +328,7 @@ func (s *BotService) ChatbotCompletion(
|
||||
// async_iframe_completion saves `user_id=kwargs.get("user_id", "")`).
|
||||
// The Go BotHandler routes pass `user.ID` through the
|
||||
// "tenantID" parameter (the Go User struct collapses user and
|
||||
// tenant into one identifier — see project CLAUDE.md), so
|
||||
// tenant into one identifier — see project AGENTS.md), so
|
||||
// writing `tenantID` here actually stores the requester's
|
||||
// user-id (== tenant-id) in the python user-id slot. The
|
||||
// session-tenant check on the read path compares against the
|
||||
|
||||
+2
-2
@@ -104,13 +104,13 @@ web-checks:
|
||||
root: "web/"
|
||||
run: '"$(../tools/hooks/web_tools.sh)/oxlint" {files}'
|
||||
# Convention guard: frontend tests grouped in a directory must use
|
||||
# __tests__/, never tests/ (see web/CLAUDE.md "Test File Placement").
|
||||
# __tests__/, never tests/ (see web/AGENTS.md "Test File Placement").
|
||||
# Lefthook skips a job whose glob matches no files, so this job only runs
|
||||
# — and fails — when a changed file sits inside a tests/ directory.
|
||||
- name: web-no-tests-dir
|
||||
glob: "web/**/tests/**"
|
||||
root: "web/"
|
||||
run: |
|
||||
echo "Forbidden test directory: frontend tests belong in __tests__/, not tests/ (web/CLAUDE.md):"
|
||||
echo "Forbidden test directory: frontend tests belong in __tests__/, not tests/ (web/AGENTS.md):"
|
||||
printf ' %s\n' {files}
|
||||
exit 1
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# CLAUDE.md
|
||||
# AGENTS.md
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with the RAGFlow frontend (`web/`).
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* Chat completion SSE streaming.
|
||||
*
|
||||
* NOTE on the network layering convention (see web/CLAUDE.md): this file
|
||||
* NOTE on the network layering convention (see web/AGENTS.md): this file
|
||||
* deliberately uses the native `fetch` API instead of the shared axios instance
|
||||
* in `@/utils/next-request`. Streaming requires access to the raw
|
||||
* `Response.body` `ReadableStream`, which axios cannot expose in the browser.
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
* oxlint `no-restricted-imports`); the only other exception is the bootstrap
|
||||
* gate in `main.tsx`.
|
||||
*
|
||||
* Conventions (see web/CLAUDE.md):
|
||||
* Conventions (see web/AGENTS.md):
|
||||
* - JSX divergence: dispatch through `<BackendVariant go={...} python={...} />`
|
||||
* at a dispatcher file (page `index.tsx` / form dispatcher), never inline
|
||||
* in business components.
|
||||
|
||||
Reference in new issue
Block a user