From c066faf07a8d1335c726be26f71125cf79e6bcc3 Mon Sep 17 00:00:00 2001 From: Zhengchao An Date: Wed, 2 Sep 2026 15:30:42 +0800 Subject: [PATCH] fix: update stale docs/README.md references to docs/architecture/README.md (#7053) fix(docs): update stale docs/README.md references to docs/architecture/README.md The file docs/README.md was removed in a previous commit but references in AGENTS.md, ARCHITECTURE.md, and CLAUDE.md were not updated. The expanded check_doc_paths.sh now catches these stale references. --- AGENTS.md | 2 +- ARCHITECTURE.md | 2 +- CLAUDE.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index acba2d9b9..757e0c969 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -86,7 +86,7 @@ This file contains repository-wide rules. Use the nearest subdirectory - CI gates: `.github/workflows/ci.yml`. - PR format: `.github/pull_request_template.md`. - Architecture routing: `ARCHITECTURE.md` and `docs/architecture/README.md`. -- Knowledge-base index and documentation rules: `docs/README.md`. +- Knowledge-base index and documentation rules: `docs/architecture/README.md`. - Agent skills: `.agents/skills/*/SKILL.md`. Do not commit one-shot plans, trackers, migration ledgers, benchmark snapshots, diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 4d85c8f23..8e4f7c043 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -62,7 +62,7 @@ rustfs/ # Workspace root (virtual manifest) │ ├── utils/ # Pure utility functions │ ├── ... # (see "Crate Reference" below) │ └── e2e_test/ # End-to-end integration tests -└── docs/ # Agent knowledge base: contracts, runbooks, testing rules (index: docs/README.md) +└── docs/ # Agent knowledge base: contracts, runbooks, testing rules (index: docs/architecture/README.md) ``` ### Main Crate Layers (`rustfs/src/`) diff --git a/CLAUDE.md b/CLAUDE.md index 7059380d3..aba7c5983 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -27,7 +27,7 @@ make build-docker BUILD_OS=ubuntu22.04 ## Where to look (do not duplicate here) -- Agent knowledge base index and doc-writing rules: [docs/README.md](docs/README.md) +- Agent knowledge base index and doc-writing rules: [docs/architecture/README.md](docs/architecture/README.md) - Crate membership: `Cargo.toml` `[workspace].members` - Architecture, layering, crate map: [ARCHITECTURE.md](ARCHITECTURE.md) - Migration guardrails & readiness contracts: [docs/architecture/](docs/architecture/README.md)