Skip to content

docs: README 전면 개편 — 대시보드 캡처·다이어그램 중심, 이력은 RESEARCH_LOG로 이관#454

Merged
easygap merged 1 commit into
mainfrom
docs/readme-refresh
Jul 10, 2026
Merged

docs: README 전면 개편 — 대시보드 캡처·다이어그램 중심, 이력은 RESEARCH_LOG로 이관#454
easygap merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@easygap

@easygap easygap commented Jul 10, 2026

Copy link
Copy Markdown
Owner

배경

README가 486줄인데 절반 이상이 2026-04~05월 research sweep 변경이력이었다. 처음 보는 사람이 "이 프로젝트가 뭘 하는지"를 파악하기 전에 candidate family 로그부터 만나는 구조 — 얼굴과 일지가 섞여 있었다.

변경

README 재작성 (486줄 → 약 240줄, 시각 자료 중심):

  • 정체성 3줄: 알파 탐색을 정직하게 실패로 결론 → 수익은 구조(분산 베타 + CD금리 파킹 + 비용 최소화 + 적립)에서 → 실전 경로는 전부 fail-closed
  • 실운영 대시보드 캡처 (docs/images/dashboard-main.png, 7/10 실화면) — 두 트랙 카드·TWR·입금 버튼이 그대로 보임
  • mermaid 다이어그램 2개: 시스템 구성(데이터→리밸런서→가드→실행→DB→관측성), 페이퍼→실전 승격 파이프라인(60영업일 게이트)
  • 운영 트랙 현황 표(7/10 기준), 일일 자동화 루틴, 안전장치는 설계 원칙 3개 + <details> 접기
  • Quick Start·프로젝트 구조·문서 표 최신화 (소액 트랙, 입금 CLI, health 종료코드 등)

이력 보존 — 삭제가 아니라 이관:

  • 운영 상태 스냅샷 이력·전략 상태·research sweep 전 기록·target-weight pilot 운영 상세를 docs/RESEARCH_LOG.md(227줄)로 원문 그대로 슬라이스 이관 (재타이핑 없음, 내용 유실 없음)
  • README 문서 표에서 링크로 연결 — "알파 탐색 실패 기록 포함"을 명시 (이 저장소의 정직성이 곧 정체성)

검증

  • 코드펜스 짝수(16), 상대 링크 9개 전부 실재, 이미지 존재, RESEARCH_LOG 링크 정상
  • mermaid는 GitHub 표준 문법(인용 라벨)만 사용

486줄짜리 README가 사실상 연구 변경이력 덤프였다. 처음 보는 사람이
프로젝트가 뭘 하는지 파악하기 전에 2026-04월 sweep 로그부터 읽게 되는 구조.

- README를 프로젝트 소개 중심으로 재작성: 정직한 결론(알파 없음 -> 구조로
  수익), 실제 운영 대시보드 캡처, 시스템 구성/승격 파이프라인 mermaid
  다이어그램 2개, 운영 트랙 현황 표(7/10 기준), 안전장치는 설계 원칙 3개 +
  세부는 접기(details)로 정리
- 운영 상태 스냅샷 이력, 전략 상태/승격 체계, research sweep 기록,
  target-weight pilot 운영 상세는 docs/RESEARCH_LOG.md로 원문 그대로 이관
  (재타이핑 없이 슬라이스 — 내용 유실 없음)
- docs/images/dashboard-main.png: 실운영 대시보드 캡처(1440x960, 두 트랙
  카드 + 수익률 추이)

검증: 코드펜스 짝수, 상대 링크 9개 전부 실재, mermaid 2블록 문법 표준 준수.
@easygap
easygap merged commit e54b92e into main Jul 10, 2026
1 check failed
@easygap
easygap deleted the docs/readme-refresh branch July 10, 2026 03:14
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