Skip to content

[docs] README 재작성 #1012

Closed
Closed

Description

@sebeeeen

작업 내용

레포지토리 공개(public) 전환을 앞두고 루트 README.md를 공개 저장소 표준 형식으로 재작성한다. FP 설계 문서(요구사항정의서·기능명세서·RNR·ONBOARDING)와 실제 코드·인프라 정의를 근거로, 코드의 현재 동작과 일치하도록 정리한다.

  • 프로젝트 한 줄 소개와 기술 배지
  • Bifrost가 해결하는 문제, 핵심 기능, 시스템 아키텍처(mermaid)
  • 기술 스택, 디렉터리 구조
  • 로컬 실행(docker-compose·Makefile·각 서비스 기준 실제 명령), 테스트와 빌드
  • 인프라와 배포(EKS·Argo CD GitOps·Jenkins·SealedSecrets) 개요
  • 팀 R&R, 문서 인덱스, 라이선스

원칙

  1. 실제 코드·문서에서 확인된 사실만 기술하고 과장·날조를 하지 않는다.
  2. 비밀값·토큰·실제 엔드포인트는 README에 포함하지 않는다.
  3. 로컬 실행·테스트 명령은 매니페스트와 서비스 README에 정의된 표면만 사용한다.

완료 조건

  • 루트 README.md 재작성
  • 비밀값·식별자 미포함 확인
  • 로컬 실행·테스트 명령이 실제 docker-compose·Makefile·gradle·uv·npm 표면과 일치

참고

Activity

  1. added
    chore설정 변경, 의존성 업데이트, 문서 작업 등
    on Jun 27, 2026
  2. changed the title [-][docs] README 재작성 — 공개 저장소용 프로젝트 소개·아키텍처·로컬 실행 정비[/-] [+][docs] README 재작성[/+] on Jun 27, 2026
  3. self-assigned this
    on Jun 27, 2026
  4. added 2 commits that reference this issue on Jun 27, 2026
  5. added a commit that references this issue on Jun 28, 2026
  6. added a commit that references this issue on Jul 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

chore설정 변경, 의존성 업데이트, 문서 작업 등

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions