팀 내 원활한 소통과 기록을 위해 Docusaurus 기반으로 개발·배포되는 문서 플랫폼입니다.
프로젝트 루트에서 다음을 실행하세요:
# 의존성 설치
npm install
# 로컬 개발 서버 실행
npm run dev브라우저가 자동으로 열리지 않으면 http://localhost:3000 을 방문하세요.
/docs 경로를 기준으로 문서 구조는 다음과 같습니다.
| 문서 종류 | 설명 |
|---|---|
| database | db와 관련된 아키텍쳐나, 구조를 다룬 문서 |
| develop-environment | 개발 환경 설정을 다룬 문서 |
| main-features | 서비스에 대한 주요 기능, 화면 설계를 다룬 문서 |
| meeting | 회의 내용을 정리한 문서 |
| project-intro | 서비스에 대한 소개 문서 |
| rules | 개발하는데 필요한 컨벤션, 문서 작성 규칙 등을 다룬 문서 |
| technical-decision | 기술과 관련하여 변경된 점, 추가된 점을 다룬 문서 |
반드시 구조에 따라 md 생성 후 문서를 작성해주세요.
/docs 경로를 제외한 나머지 폴더는 건들지 말아주세요.
main 브랜치에 커밋/푸시하면 GitHub Actions를 통해 gh-pages로 자동 배포됩니다.
배포 상태는 리포지토리의 Actions 탭에서 확인하세요.
- 문서 제목과 파일명은 일관된 네이밍을 사용하세요.
- 변경 사항은 PR과 함께
changelog에 추가하세요. - 도표·이미지는
/static또는 해당 문서 폴더 내에 함께 관리하세요. - 카테고리 및 사이드바 반영을 위해 필요한 경우
sidebars.js를 업데이트하세요. - 문서 상단에 메타데이터(예:
title,sidebar_position)를 적절히 설정하세요.
- Node.js LTS 권장
- npm 최신 버전
문서 개선은 언제나 환영합니다. 작은 수정을 자주 반영해 주세요!