Plextype Docsv0.9.2
Guides
시작하기
setup, DB 초기화, 개발 서버 실행
프로젝트 구조
코어와 개인 확장 영역
Extensions
index.tsx, admin registry, trigger 등록
Layouts & Page
기본 레이아웃과 홈 페이지 교체
Project API
proxy, Prisma, 배포판 확장 규칙
Posts
게시판 스킨과 issuetracker 구조
Components
공통 UI 컴포넌트 사용 기준
Previews
기본 제공 화면 확인
운영 규칙
upstream 패치와 커스텀 충돌 방지
Documentation
문서 작성과 유지 기준
Documentation

Documentation

docs 문서를 어떤 기준으로 유지해야 하는지 정리한 문서 작성 가이드입니다.

문서의 목적

/docs 문서는 배포판을 받아간 사람이 프로젝트를 이해하고 커스텀할 때 보는 작업 매뉴얼입니다.

특히 Gjworks 구조는 코어와 extensions의 경계가 중요합니다. 문서는 이 경계를 반복해서 설명해야 사용자가 코어 업데이트를 받으면서도 자기 프로젝트의 변경사항을 안전하게 유지할 수 있습니다.

권장 구성

각 문서는 “개념 설명”, “파일 위치”, “사용 예시”, “주의점”을 기본 단위로 작성합니다.

1. 이 기능이 왜 필요한지 설명
2. 관련 파일과 alias 안내
3. 실제 추가 또는 교체 예시
4. 코어 업데이트 시 주의할 점
5. 빌드나 실행으로 확인하는 방법

문서 폭

문서는 넓은 대시보드가 아니라 읽기 화면입니다. 그래서 본문은 너무 넓게 펼치지 않고, 코드와 테이블도 max-w를 제한합니다.

Plextype Docsv0.9.2Extensions first, core clean.
ⓒ gjworks
On this page
문서의 목적권장 구성문서 폭
Recent changes
fix: pwa 안정화 및 plextype 릴리즈 배포 안되는 문제점 수정
v0.9.2086f23b