Skip to content

온라인 문서 유지보수 참여

처음 참여하나요? 질문, PR, 유지보수자 경로는 먼저 **커뮤니티 참여**를 확인하세요.

온라인 문서 사이트: https://notionnext.tangly1024.com

소스와 GitHub의 Markdown은 일대일로 대응합니다. 저장소 수정 → main 병합 → 자동 게시 흐름입니다.

문서 수정 하나하나는 이후 사이트 운영자가 한 번 덜 헤매도록 돕습니다. 문서 유지보수에 참여한 개발자는 문서 커밋 기록감사의 말에 나타납니다.

현재 페이지 수정

모든 가이드 페이지 하단에는 **「GitHub에서 이 페이지 편집」**이 있으며, 해당 파일 편집 화면으로 바로 이동합니다.

문서 디렉터리 보기

링크설명
docs/디렉터리 설명(이 README는 GitHub에서 보임)
docs/user-guide/사용 가이드, 테마 설정, 운영과 유지보수
docs/developer/아키텍처, 기여, 테마 마이그레이션, 유지보수 문서(온라인 사이트에 표시)

권장 흐름(기여자)

  1. notionnext-org/NotionNext를 Fork하거나 조직 저장소 쓰기 권한을 갖습니다.
  2. docs/user-guide/**/*.md 또는 docs/developer/**/*.md를 편집합니다(테마 설정 표는 node scripts/generate-theme-user-docs.mjs 실행 가능).
  3. 로컬 미리보기: yarn docs:site:dev
  4. PR을 제출하고, **main**에 병합되면 GitHub Actions가 배포합니다.

자세한 체크리스트: MAINTENANCE_WORKFLOW.md · 정책: DOCUMENTATION_POLICY.md

배포 원리(요약)

text
push main(docs/user-guide/ 등 변경)
    → GitHub Actions: yarn docs:site:build
    → .vitepress/dist → Cloudflare Pages

자세한 내용은 cloudflare-pages-docs.md를 참고하세요.

구버전 온라인 매뉴얼과의 관계

docs.tangly1024.com은 과거 Notion 호스팅 문서입니다. docs/user-guide/와 notionnext.tangly1024.com을 기준으로 합니다.

  • slug 대응표와 구버전 사이트 바로가기: help/legacy-docs.md · ARTICLE_INDEX.md
  • 선택적 구버전 글 일괄 가져오기: node scripts/migrate-legacy-docs.mjs --slug <slug>(--images를 추가하면 이미지를 docs/public/legacy/로 다운로드)

문서 사이트 댓글(Giscus)

각 가이드 페이지 하단에는 문서 피드백이 표시될 수 있습니다(Giscusnotionnext-org/NotionNext 저장소의 GitHub Discussions).

현재 저장소 기본 카테고리 General을 재사용합니다(Discussions에서 확인 가능).

변수값(공개 ID, 비밀 키 아님)
VITE_GISCUS_REPO_IDR_kgDOGHdxTw
VITE_GISCUS_CATEGORY_IDDIC_kwDOGHdxT84CBR2I

GitHub Actions: 조직 저장소 Secrets에 위 두 항목이 설정되어 있습니다(빌드 workflow가 자동 주입).
로컬 미리보기: 루트의 .env.docs.example.env.local로 복사한 뒤 yarn docs:site:dev를 실행합니다.
Cloudflare 직접 빌드: Actions를 사용하지 않는다면 Pages 환경 변수에 위 두 항목을 입력합니다.

선택적으로 VITE_GISCUS_ENABLED=false를 설정하면 댓글 영역을 끌 수 있습니다. ID가 설정되지 않으면 페이지 하단에는 Issue 링크만 표시됩니다. 단일 페이지 frontmatter: comments: false.