문서의 목적
/docs 문서는 배포판을 받아간 사람이 프로젝트를 이해하고 커스텀할 때 보는 작업 매뉴얼입니다.
특히 Gjworks 구조는 코어와 extensions의 경계가 중요합니다. 문서는 이 경계를 반복해서 설명해야 사용자가 코어 업데이트를 받으면서도 자기 프로젝트의 변경사항을 안전하게 유지할 수 있습니다.
권장 구성
각 문서는 “개념 설명”, “파일 위치”, “사용 예시”, “주의점”을 기본 단위로 작성합니다.
1. 이 기능이 왜 필요한지 설명
2. 관련 파일과 alias 안내
3. 실제 추가 또는 교체 예시
4. 코어 업데이트 시 주의할 점
5. 빌드나 실행으로 확인하는 방법문서 폭
문서는 넓은 대시보드가 아니라 읽기 화면입니다. 그래서 본문은 너무 넓게 펼치지 않고, 코드와 테이블도 max-w를 제한합니다.
현재 문서 원본
- Markdown 가이드:
src/extensions/docs/_docs/*.md - 문서 목록·페이지 구현:
src/extensions/docs/routes/docs/ - 문서 연결 목록:
src/extensions/docs/routes.json - 사이드 메뉴:
src/extensions/docs/nav.ts - 공통 문서 UI:
src/extensions/docs/components.tsx - 컴포넌트·모달 설명:
src/extensions/docs/ComponentsPage.tsx,src/extensions/docs/ModalDocsPage.tsx
src/app/(extensions)/docs는 연결 파일 영역입니다. 본문은 원본에서 수정하고, URL·export를 바꿀 때 연결 목록 수정과 extensions:sync가 필요합니다.
구조 변경 시 점검
/docs첫 화면, 메뉴 설명, 관련 가이드, AGENTS.md 예시의 경로를 함께 맞춥니다.- 코어 모듈과 이를 확장하는 기능·스킨을 합치는 것으로 설명하지 않습니다.
- 실제 파일 경로와 새 기능을 가정한 예시를 구분합니다.
- 라우트 동기화, registry·Trigger 연결, 스키마 합성, DB 적용을 서로 다른 절차로 설명합니다.
- 미구현 자동 설치나 삭제 기능을 지원하는 것처럼 적지 않습니다.
- 명령은 해당 배포판의 package.json과 스크립트를 확인하고, 운영 DB 변경은 승인·백업 전제를 명시합니다.
- JSON 예시, 코드 블록, 내부 링크와 페이지 렌더링을 확인합니다.