Skip to content

docs: 문서 구조 정리와 최종 통합 검증 기록 보완 - #36

Merged
GlancingMonkey merged 1 commit into
developfrom
codex/docs-refresh-20261105
Nov 4, 2026
Merged

GlancingMonkey merged 1 commit into
developfrom
codex/docs-refresh-20261105

Conversation

@GlancingMonkey

Copy link
Copy Markdown
Owner

문서 진입 경로가 흩어져 있고 Extension 생성기 안내와 일부 저장 예시가 현재 동작을 충분히 설명하지 못했습니다. README를 프로젝트 소개·현재 기능·실행·검증 근거 중심으로 정리하고, 문서 목차에서 필요한 가이드로 이동할 수 있게 했습니다.

변경

  • 기존 아이콘과 처리 흐름도를 활용한 README, 목적별 문서 목차.
  • 새 시스템 구조·시연 순서·테스트 안내·후속 개발 계획.
  • 기존 실행 가이드의 migration 순서와 HTTP 503 본문 확인 보완.
  • Extension의 함수 자동 인식 조건·Workspace 설정·Top-K 내 UI 필터 범위 명확화. 생성기 Hello World 안내 제거.
  • 재처리 예시가 고정 ID 5를 사용하지 않도록 실제 프로젝트·ID 입력 방식으로 정리.
  • 11월 5일 보고서에 develop 5dd2edc 병합 후 ID 8, API·DB·UI 대조, 복사·삽입, 검색 빈 결과·오류 시험 및 복구 기록 추가. 근거: [11/04][Extension] 저장·임베딩 상태 안내와 새 코드 검색 확인 #29, [11/04][공통] 자동 임베딩 develop 통합·실패 재처리 검증 #30. 병합 전 ID 6·7 기록은 보존.

API_CONTRACT.md, 기능 코드, DB SQL, 의존성, 기존 Embedding 실험 산출물은 변경하지 않았습니다. 후속 계획은 일정이나 새 API를 확정한 계약이 아니며 RAG/LLM을 완료 기능으로 표시하지 않습니다.

검증

  • 최신 develop 5dd2edc와 로컬 74개 추적 파일 내용 일치 확인 후 작성.
  • 변경은 Markdown 14개 파일뿐이며 새 문서는 5개.
  • 내부 링크·이미지 경로 137개, 코드 블록 닫힘, 공백 검사 통과.
  • Python 예시 6개 구문 분석, JSON 예시 4개 파싱, PowerShell 블록 8개 구문 분석 통과.
  • Bash 예시는 검토했으나 자동 구문 검사기는 실행 환경 접근 제한으로 시작되지 않았습니다.
  • 이번 작업은 문서 정리입니다. 기존 25개 Python·26개 Extension 테스트 및 실제 DB 결과는 당시 기록을 검토한 것이며 재실행한 결과로 쓰지 않았습니다.

@GlancingMonkey
GlancingMonkey merged commit dff6217 into develop Nov 4, 2026
@GlancingMonkey
GlancingMonkey deleted the codex/docs-refresh-20261105 branch November 4, 2026 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant