fran/rustfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: update stale docs/README.md references to docs/architecture/README.md (#7053)

Browse Source 
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.
This commit is contained in:
Zhengchao An
2026-09-02 15:30:42 +08:00
committed by GitHub
parent ca8bbbf8f3
commit c066faf07a
3 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+1 -1
View File
@@ -86,7 +86,7 @@ This file contains repository-wide rules. Use the nearest subdirectory
- CI gates: `.github/workflows/ci.yml`. - CI gates: `.github/workflows/ci.yml`.
- PR format: `.github/pull_request_template.md`. - PR format: `.github/pull_request_template.md`.
- Architecture routing: `ARCHITECTURE.md` and `docs/architecture/README.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`. - Agent skills: `.agents/skills/*/SKILL.md`.
Do not commit one-shot plans, trackers, migration ledgers, benchmark snapshots, Do not commit one-shot plans, trackers, migration ledgers, benchmark snapshots,
ARCHITECTURE.md
+1 -1
View File
@@ -62,7 +62,7 @@ rustfs/ # Workspace root (virtual manifest)
│ ├── utils/ # Pure utility functions │ ├── utils/ # Pure utility functions
│ ├── ... # (see "Crate Reference" below) │ ├── ... # (see "Crate Reference" below)
│ └── e2e_test/ # End-to-end integration tests │ └── 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/`) ### Main Crate Layers (`rustfs/src/`)
CLAUDE.md
+1 -1
View File
@@ -27,7 +27,7 @@ make build-docker BUILD_OS=ubuntu22.04
## Where to look (do not duplicate here) ## 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` - Crate membership: `Cargo.toml` `[workspace].members`
- Architecture, layering, crate map: [ARCHITECTURE.md](ARCHITECTURE.md) - Architecture, layering, crate map: [ARCHITECTURE.md](ARCHITECTURE.md)
- Migration guardrails & readiness contracts: [docs/architecture/](docs/architecture/README.md) - Migration guardrails & readiness contracts: [docs/architecture/](docs/architecture/README.md)