Skip to content

사이트 운영 원칙

목적

이 사이트는 GitHub 프로젝트를 단순 나열하지 않고, 각 프로젝트가 왜 존재하는지 설명하는 문서형 포트폴리오를 유지하는 것을 목표로 합니다.

운영 기준

  • 프로젝트 추가 시 projects/index.md와 개별 상세 문서를 함께 갱신합니다.
  • 상세 문서는 공통 frontmatter와 공통 섹션 구조를 유지합니다.
  • 프로젝트 설명은 기능 나열보다 문제 정의와 구현 의사결정을 우선합니다.
  • 운영 메모, 배포 절차, 작성 규칙은 archive/ 아래에 유지합니다.
  • 대외 공개용 문서는 도메인, 저장소 링크, 배포 상태를 주기적으로 점검합니다.

업데이트 흐름

  1. 프로젝트 문서 작성 또는 수정
  2. 로컬에서 npm run docs:build 확인
  3. GitHub에 push
  4. Cloudflare Pages 자동 배포 확인

공개 품질 기준

  • 내부 링크가 깨지지 않아야 합니다.
  • 대표 문서는 문제/목적, 주요 기능, 기술 스택, 링크를 포함해야 합니다.
  • 도메인 변경이나 배포 구조 변경이 있으면 관련 아카이브 문서도 같이 수정합니다.

Moonworld Docs on Cloudflare Pages