docs: add top-level documentation hub index (#362) #367

agentson · 2026-03-01T23:23:44+09:00

agentson commented

2026-03-01 23:23:44 +09:00

Linked Issue

Closes docs: top-level docs index(docs/README.md) 도입 (#362)

Summary

상위 문서 라우팅 허브 docs/README.md 신설
문서 우선순위(SSOT)와 권장 읽기 순서 정의
README.md, CLAUDE.md 문서 섹션에 허브 진입 링크 추가

Scope

신규: docs/README.md
갱신: README.md, CLAUDE.md

Scope Mapping

REQ: REQ-OPS-002, REQ-OPS-003
TASK: TASK-OPS-002, TASK-OPS-003
TEST: TEST-ACC-008, TEST-ACC-009

Validation

python3 scripts/validate_ouroboros_docs.py
python3 scripts/validate_governance_assets.py
python3 scripts/validate_docs_sync.py

## Linked Issue - Closes #362 ## Summary - 상위 문서 라우팅 허브 `docs/README.md` 신설 - 문서 우선순위(SSOT)와 권장 읽기 순서 정의 - `README.md`, `CLAUDE.md` 문서 섹션에 허브 진입 링크 추가 ## Scope - 신규: `docs/README.md` - 갱신: `README.md`, `CLAUDE.md` ## Scope Mapping - REQ: `REQ-OPS-002`, `REQ-OPS-003` - TASK: `TASK-OPS-002`, `TASK-OPS-003` - TEST: `TEST-ACC-008`, `TEST-ACC-009` ## Validation - `python3 scripts/validate_ouroboros_docs.py` - `python3 scripts/validate_governance_assets.py` - `python3 scripts/validate_docs_sync.py`

agentson added 1 commit 2026-03-01 23:23:45 +09:00

docs: add top-level documentation hub index (#362 )

Gitea CI / test (push) Successful in 39s

Details

Gitea CI / test (pull_request) Successful in 35s

Details

d2ac0dae53

agentson commented

2026-03-01 23:25:19 +09:00

코드 리뷰 — PR #367

개요

docs/README.md 문서 허브 신설 + README.md/CLAUDE.md에 허브 진입 링크 추가. 단일 커밋, 3파일, 48 additions.

검증 결과: validate_docs_sync.py / validate_ouroboros_docs.py / validate_governance_assets.py 모두 PASS. docs/README.md 내 25개 링크 전부 유효.

🟡 확인 필요

1. `docs/agent-constraints.md`, `docs/skills.md`가 Document Map에 없음

docs/*.md 목록과 허브 링크를 대조하면 두 파일이 누락됐다.

파일	역할
`docs/agent-constraints.md`	에이전트 영속 제약 기록 (`agents.md`와 구별됨)
`docs/skills.md`	개발 도구/스킬 가이드

의도적으로 제외했다면 Change Rule 섹션이나 별도 주석으로 이유를 명시하는 것이 좋다. 포함 대상이라면 Document Map에 추가가 필요하다.

✅ 좋은 점

링크 전수 유효 — Priority / Reading Order / Document Map 3개 섹션 25개 링크 모두 실존 파일 확인.
상대경로만 사용 — 절대경로 없음.
Change Rule 명시 — 문서 신규/이동 시 허브 갱신 의무를 문서 내에 직접 정의.
범위 깔끔 — 단일 커밋, 허브 신설 + 진입 링크 추가만.

수정 사항 요약

우선순위	위치	내용
🟡	`docs/README.md`	`agent-constraints.md`, `skills.md` 포함 여부 결정 및 반영

## 코드 리뷰 — PR #367 ### 개요 `docs/README.md` 문서 허브 신설 + `README.md`/`CLAUDE.md`에 허브 진입 링크 추가. 단일 커밋, 3파일, 48 additions. 검증 결과: `validate_docs_sync.py` / `validate_ouroboros_docs.py` / `validate_governance_assets.py` 모두 PASS. `docs/README.md` 내 25개 링크 전부 유효. --- ### 🟡 확인 필요 #### 1. `docs/agent-constraints.md`, `docs/skills.md`가 Document Map에 없음 `docs/*.md` 목록과 허브 링크를 대조하면 두 파일이 누락됐다. | 파일 | 역할 | |------|------| | `docs/agent-constraints.md` | 에이전트 영속 제약 기록 (`agents.md`와 구별됨) | | `docs/skills.md` | 개발 도구/스킬 가이드 | 의도적으로 제외했다면 `Change Rule` 섹션이나 별도 주석으로 이유를 명시하는 것이 좋다. 포함 대상이라면 Document Map에 추가가 필요하다. --- ### ✅ 좋은 점 - **링크 전수 유효** — Priority / Reading Order / Document Map 3개 섹션 25개 링크 모두 실존 파일 확인. - **상대경로만 사용** — 절대경로 없음. - **Change Rule 명시** — 문서 신규/이동 시 허브 갱신 의무를 문서 내에 직접 정의. - **범위 깔끔** — 단일 커밋, 허브 신설 + 진입 링크 추가만. --- ### 수정 사항 요약 | 우선순위 | 위치 | 내용 | |----------|------|------| | 🟡 | `docs/README.md` | `agent-constraints.md`, `skills.md` 포함 여부 결정 및 반영 |

agentson added 1 commit 2026-03-01 23:26:29 +09:00

docs: include agent constraints and skills in docs hub

Gitea CI / test (push) Successful in 35s

Details

Gitea CI / test (pull_request) Successful in 33s

Details

a36e85b708

agentson commented

2026-03-01 23:26:34 +09:00

리뷰 포인트 반영했습니다.

docs/README.md Document Map(Core)에 누락된 2개 문서 추가
- agent-constraints.md: 영속 제약/운영 불변식
- skills.md: 스킬 목록/활용 가이드

검증:

python3 scripts/validate_docs_sync.py
python3 scripts/validate_ouroboros_docs.py
python3 scripts/validate_governance_assets.py
모두 통과했습니다.

리뷰 포인트 반영했습니다. - `docs/README.md` Document Map(Core)에 누락된 2개 문서 추가 - `agent-constraints.md`: 영속 제약/운영 불변식 - `skills.md`: 스킬 목록/활용 가이드 검증: - `python3 scripts/validate_docs_sync.py` - `python3 scripts/validate_ouroboros_docs.py` - `python3 scripts/validate_governance_assets.py` 모두 통과했습니다.

agentson commented

2026-03-01 23:28:39 +09:00

팔로업 리뷰 — PR #367 (커밋 `a36e85b7`)

이슈 해결 확인

이슈	상태
🟡 `agent-constraints.md`, `skills.md` Document Map 미수록	✅ 해결

세부 확인

agent-constraints.md: Core 섹션에 "영속 제약/운영 불변식(agents.md 보완)" 설명과 함께 추가됨.
skills.md: Core 섹션에 "설치/사용 가능한 스킬 목록과 활용 가이드" 설명과 함께 추가됨.
docs/*.md 전수 커버 확인 — 허브에 빠진 파일 없음.
링크 27개 전수 유효, validate_docs_sync.py PASS.

Merge-ready. 모든 지적 사항 해결됨.

## 팔로업 리뷰 — PR #367 (커밋 a36e85b7) ### 이슈 해결 확인 | 이슈 | 상태 | |------|------| | 🟡 `agent-constraints.md`, `skills.md` Document Map 미수록 | ✅ 해결 | ### 세부 확인 - `agent-constraints.md`: Core 섹션에 "영속 제약/운영 불변식(agents.md 보완)" 설명과 함께 추가됨. - `skills.md`: Core 섹션에 "설치/사용 가능한 스킬 목록과 활용 가이드" 설명과 함께 추가됨. - `docs/*.md` 전수 커버 확인 — 허브에 빠진 파일 없음. - 링크 27개 전수 유효, `validate_docs_sync.py` PASS. --- **Merge-ready.** 모든 지적 사항 해결됨.

jihoson merged commit 15e45fd099 into feature/v3-session-policy-stream

2026-03-01 23:29:49 +09:00

jihoson deleted branch feature/issue-362-docs-index

2026-03-01 23:29:49 +09:00

jihoson referenced this issue from a commit

2026-03-01 23:29:50 +09:00

Merge pull request 'docs: add top-level documentation hub index (#362)' (#367) from feature/issue-362-docs-index into feature/v3-session-policy-stream

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: jihoson/The-Ouroboros#367

docs: add top-level documentation hub index (#362) #367

Linked Issue

Summary

Scope

Scope Mapping

Validation

코드 리뷰 — PR #367

개요

🟡 확인 필요

1. docs/agent-constraints.md, docs/skills.md가 Document Map에 없음

✅ 좋은 점

수정 사항 요약

팔로업 리뷰 — PR #367 (커밋 a36e85b7)

이슈 해결 확인

세부 확인

1. `docs/agent-constraints.md`, `docs/skills.md`가 Document Map에 없음

팔로업 리뷰 — PR #367 (커밋 `a36e85b7`)