docs: 문서 룰 정리 + index 보강 + web-backlog 청소 + 핸드오프#83
Conversation
- docConventions.md (신규): tunaflow 의 versioning + navigation 정책을 secall 컨텍스트로 압축. CLAUDE.md §3 의 expanded 버전. - reference/index.md: 누락된 10개 파일 등록 + 상태 라벨 + 5단계 추천 읽기 순서. - web-backlog.md: P79/P75/P78 머지로 해소된 4건 제거 (hot 2→0, debt 5→3, watch 4→3). - handoff_2026-05-19.md (신규): v0.5.0 + 10 PR 머지 시점 cold-start 인수인계. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request establishes a formal documentation convention for the project, introduces a detailed session handoff for 2026-05-19, and updates the reference index and web backlog. The reviewer identified several consistency issues within the new documentation rules, including discrepancies in naming conventions compared to the root CLAUDE.md, singular versus plural type definitions, and inconsistent path formatting. Additionally, corrections were suggested for the handoff document's status and PR count accuracy.
| ### Reference (`docs/reference/`) | ||
|
|
||
| - **날짜 없는 안정 이름** 을 기본으로 한다 (예: `core-backlog.md`, `llm-config.md`). | ||
| - 2~4 토큰의 camelCase 또는 kebab-case 가 가능하다. 기존 폴더가 kebab-case 중심이면 따른다. |
There was a problem hiding this comment.
루트의 CLAUDE.md 36행에서는 파일명 규칙으로 camelCase를 명시하고 있으나, 여기서는 kebab-case도 허용하고 있습니다. CLAUDE.md가 요약본이고 이 문서가 확장판임을 고려하더라도, 규칙의 일관성을 위해 하나로 통일하거나 CLAUDE.md를 업데이트하여 명시적인 허용 범위를 맞추는 것이 좋습니다.
| - 2~4 토큰의 camelCase 또는 kebab-case 가 가능하다. 기존 폴더가 kebab-case 중심이면 따른다. | |
| - 2~4 토큰의 camelCase를 기본으로 한다. (기존 kebab-case 파일들과의 일관성이 필요한 경우에만 예외적 허용) |
|
|
||
| ```yaml | ||
| --- | ||
| type: reference # reference | plan | prompt | review | insight | baseline | community | agent |
There was a problem hiding this comment.
frontmatter의 type 값들과 1절에서 정의한 디렉토리 명칭 간에 단수/복수 표현이 혼용되고 있습니다 (예: plan vs plans/, agent vs agents/). 에이전트가 일관되게 인식하고 분류할 수 있도록 디렉토리명과 맞추어 통일하는 것을 권장합니다.
| type: reference # reference | plan | prompt | review | insight | baseline | community | agent | |
| type: reference # reference | plans | prompts | reviews | insight | baseline | community | agents |
| ```yaml | ||
| --- | ||
| type: reference # reference | plan | prompt | review | insight | baseline | community | agent | ||
| status: in_progress # 아래 §3.1 참고 |
There was a problem hiding this comment.
type: reference인 예시에서 status: in_progress를 사용하는 것은 3.1절의 설명(plan/prompt 주로 사용)과 상충될 수 있습니다. reference 타입의 일반적인 상태인 done 또는 draft를 예시로 사용하는 것이 더 적절합니다.
| status: in_progress # 아래 §3.1 참고 | |
| status: done # 아래 §3.1 참고 |
| status: in_progress # 아래 §3.1 참고 | ||
| updated_at: 2026-05-19 # YYYY-MM-DD | ||
| canonical: true # false 이면 SSOT 아님 (브레인스토밍/비교 문서) | ||
| superseded_by: path # 대체된 경우만 |
There was a problem hiding this comment.
path 대신 실제 사용될 법한 예시 경로를 적어두면 에이전트가 형식을 파악하는 데 도움이 됩니다.
| superseded_by: path # 대체된 경우만 | |
| superseded_by: docs/reference/new_file.md # 대체된 경우만 |
| - `related: [path1, path2]` — 함께 읽으면 좋은 문서 | ||
| - `paired_plan: docs/plans/foo.md` — 이 prompt 와 짝인 plan | ||
| - `paired_prompt: docs/prompts/2026-05-19/foo.md` | ||
| - `supersedes: docs/reference/oldFoo.md` — 이 문서가 대체한 과거 문서 | ||
| - `superseded_by: docs/reference/newFoo.md` — 이 문서를 대체한 신규 문서 | ||
| - `read_before: [path]` — 이 문서를 읽기 전에 먼저 봐야 할 문서 |
There was a problem hiding this comment.
관계 메타데이터에서 사용하는 경로 형식이 프로젝트 루트 기준(docs/...)인지, 현재 파일 기준 상대 경로인지 명시하는 것이 좋습니다. 130-134행의 예시는 루트 기준인 반면, 200행의 예시는 상대 경로를 사용하고 있어 에이전트나 사용자가 혼동할 수 있습니다. 프롬프트나 자동화 도구의 효율성을 위해 하나로 통일하는 것을 권장합니다.
| @@ -0,0 +1,260 @@ | |||
| --- | |||
| type: reference | |||
| status: draft | |||
There was a problem hiding this comment.
세션이 종료되고 인수인계를 위해 확정된 문서라면 status를 done으로 설정하는 것이 docConventions.md의 규약에 더 부합합니다.
| status: draft | |
| status: done |
|
|
||
| # seCall 세션 핸드오프 — 2026-05-19 | ||
|
|
||
| > 작성 배경: v0.5.0 release 직후 누적된 9건의 PR (#72~#81) 머지 + Gemini 리뷰 반영 + 사용자 환경 (statusline / python hook) 보정까지 한 세션에서 끝난 시점. 컨텍스트 90% 도달로 새 세션으로 이관. cold-start 세션이 같은 흐름으로 이어갈 수 있도록 모든 결정/사고/규칙을 한 곳에 정리한다. |
There was a problem hiding this comment.
작성 배경에는 "9건의 PR"이라고 언급되어 있으나, 명시된 범위(#72~#81)와 2.1절의 목록을 확인하면 총 10건이 맞습니다. 정보의 정확성을 위해 숫자를 수정해 주세요.
| > 작성 배경: v0.5.0 release 직후 누적된 9건의 PR (#72~#81) 머지 + Gemini 리뷰 반영 + 사용자 환경 (statusline / python hook) 보정까지 한 세션에서 끝난 시점. 컨텍스트 90% 도달로 새 세션으로 이관. cold-start 세션이 같은 흐름으로 이어갈 수 있도록 모든 결정/사고/규칙을 한 곳에 정리한다. | |
| > 작성 배경: v0.5.0 release 직후 누적된 10건의 PR (#72~#81) 머지 + Gemini 리뷰 반영 + 사용자 환경 (statusline / python hook) 보정까지 한 세션에서 끝난 시점. 컨텍스트 90% 도달로 새 세션으로 이관. cold-start 세션이 같은 흐름으로 이어갈 수 있도록 모든 결정/사고/규칙을 한 곳에 정리한다. |
일관성 5건 (docConventions.md): - line 76: camelCase 기본 명시 (kebab-case는 예외적 허용으로 한정) - line 109: frontmatter type 값을 디렉토리명과 단/복수 통일 (plan→plans, prompt→prompts, review→reviews, agent→agents) - line 110: status 예시 in_progress → done (reference 타입에 적합) - line 113: superseded_by 가상 path → 실제 경로 형식 예시 - line 134: "경로는 프로젝트 루트 기준 (docs/...)으로 통일" 명시 추가 factual 2건 (handoff_2026-05-19.md): - line 3: status draft → done (인수인계 확정 문서) - line 10: "누적된 9건의 PR" → "10건" Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Gemini 리뷰 7건 모두 반영했습니다 (commit be471b0). 일관성 5건 + factual 2건. |
1 participant
Summary
docs/reference/docConventions.md신설 — tunaflow 의 versioning + navigation 두 정책을 secall 컨텍스트로 압축. 8개 디렉토리 역할, 파일명, frontmatter, index, 버전관리, 아카이브, 4단계 체크리스트 포함. CLAUDE.md §3 의 expanded 버전.docs/reference/index.md보강 — 누락된 10개 파일 모두 등록 + 상태 라벨 + 5단계 추천 읽기 순서. 기존 CLI Reference 표 보존.docs/reference/web-backlog.md청소 — PR fix(web): P66 follow-up — wiki frontmatter strip + heading collapse 폐기 + ModelInput dropdown #79 (P66 f/u) + feat(web): P66 — MarkdownView 폴딩/highlight/wikilink 확장 #75 (P66) + feat(llm): P65 — backend 별 model discovery + cache + REST endpoint #78 (P65) 머지로 해소된 4건 제거 (hot 2→0, debt 5→3, watch 4→3).docs/reference/handoff_2026-05-19.md신설 — v0.5.0 + 10 PR (feat(web): P62 — TopNav version 표시를 server SSOT 로 통합 #72~feat(web): P81 — Obsidian callout (> [!type]-) 을<details>로 렌더링 #81) 머지 + 사용자 환경 보정 완료 시점 cold-start 인수인계 문서.Why
Test plan
🤖 Generated with Claude Code