docs: design flattened redis document layout
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
# Redis 문서 구조 평탄화 설계
|
||||
|
||||
## 목적
|
||||
|
||||
`.run/` 바로 아래에 흩어진 Redis 시리즈 런 20개를 하나의 `.run/redis/` 디렉터리로 모은다. 각 글은 별도 디렉터리의 `final/document.md`가 아니라 내용을 드러내는 `redis-*.md` 파일로 보관한다.
|
||||
|
||||
## 목표 구조
|
||||
|
||||
```text
|
||||
.run/redis/
|
||||
├── redis-advanced-surfaces.md
|
||||
├── redis-backend-policy-boundary.md
|
||||
├── redis-cache-code-walkthrough.md
|
||||
└── ...
|
||||
```
|
||||
|
||||
기존 `.run/redis-<slug>/final/document.md`는 `.run/redis/redis-<slug>.md`로 일대일 이동한다. 파일 이름에는 현재 디렉터리 이름을 그대로 사용하므로 문서의 정체성과 시리즈 순서는 바뀌지 않는다.
|
||||
|
||||
## 변경 범위
|
||||
|
||||
- Redis 문서 20개를 새 경로로 이동한다.
|
||||
- Redis 문서 사이의 이전 글, 다음 글, 전체 지도, 운영 흐름 링크를 새 경로로 바꾼다.
|
||||
- `README.md`와 `CLAUDE.md`의 문서 위치 설명과 Redis 인벤토리를 새 구조에 맞춘다.
|
||||
- 문서 본문, 제목, 코드, 수치, 출처 링크는 변경하지 않는다.
|
||||
- Redis 이외의 `.run` 디렉터리와 사용자가 작업 중인 다른 변경은 수정하지 않는다.
|
||||
|
||||
## 경로 규칙
|
||||
|
||||
- Redis 시리즈: `.run/redis/redis-<slug>.md`
|
||||
- 그 밖의 기존 런: `.run/<slug>/final/document.md`
|
||||
|
||||
Redis 문서에는 다이어그램이나 측정 자료가 없으므로 이번 변경에서 `assets/`나 `evidence/` 구조는 만들지 않는다. 이후 Redis 시리즈에 부속 자료가 생기면 `.run/redis/assets/<document-slug>/` 또는 `.run/redis/evidence/<document-slug>/`처럼 문서별 하위 디렉터리를 둘 수 있지만, 이는 이번 작업 범위에 포함하지 않는다.
|
||||
|
||||
## 검증 기준
|
||||
|
||||
1. `.run/redis/`에 `redis-*.md` 파일이 정확히 20개 있어야 한다.
|
||||
2. 기존 `.run/redis-*/final/document.md`와 빈 상위 디렉터리가 남지 않아야 한다.
|
||||
3. 저장소에 이전 `.run/redis-*/final/document.md` 경로를 가리키는 참조가 없어야 한다.
|
||||
4. Redis 문서 내부에서 `.run/redis/*.md`를 가리키는 모든 링크 대상이 존재해야 한다.
|
||||
5. 이동 전후 각 문서의 본문은 경로 링크 변경을 제외하면 같아야 한다.
|
||||
Reference in New Issue
Block a user