문서 규격

게임 하나의 와이어프레임 · 규칙 · 변경 이력은 docs/games/<game>/ 한 폴더에 HTML로 쓴다. 그 HTML이 원본이고, 사이트는 파일을 변환 없이 그대로 서빙한다. 버전은 git이 관리하므로 문서 안에 버전·상태 필드를 두지 않는다. 아래 규칙은 bun run docs:check가 검사하고 CI가 막는다.

01폴더 구조

게임 폴더 하나 = 탭 세 개(개요 · 규칙 · 변경 이력).

파일 data-docs-page 내용
index.html (필수) overview 게임 소개와 와이어프레임 페이지 목차. <meta name="description">가 카탈로그 카드 문구.
wireframe/*.html (1개 이상) wireframe 토큰 · 컴포넌트 · 화면 · 상태 페이지. 하위 폴더(wireframe/states/) 허용.
rule.html (필수) rule 규칙.
changelog.html (필수) changelog 변경 이력. 최신 항목이 위. 항목은 <article class="docs-entry">.
tokens.css — 토큰 파이프라인 생성물(bun run tokens:build). 손으로 고치지 않는다.
game.css, assets/ — 게임 전용 스타일 · 이미지(선택).

02페이지 규칙

03공통 컴포넌트

옛 와이어프레임 셸의 wf-* 클래스를 그대로 쓴다.

하단 step-nav · 상태 전환

docs.js보다 먼저 window.WF = { prev, next, states }를 선언하면 하단 바가 생긴다. 옛 셸과 같은 계약이라 페이지 수정 없이 옮겨진다.

변경 이력 항목

리플레이 화면 정리

  • NEW다크 모드
  • FIX카드 숫자 대비

04페이지 뼈대

wireframe/03-screen.html 예시. 다른 페이지는 경로 깊이와 data-docs-page만 다르다.

<!doctype html>
<html lang="ko">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="docs-game" content="run-horses">
    <title>말달리자 · 03 화면</title>
    <link rel="stylesheet" href="../../_theme/docs.css">
    <link rel="stylesheet" href="../tokens.css">
    <script src="../../_theme/docs.js"></script>
  </head>
  <body data-docs-page="wireframe">
    <main class="wf-main">…</main>
  </body>
</html>

05게시

방법 명령 · 동작
미리보기 bun run docs:serve — 배포본과 같은 트리를 로컬에서.
검사 bun run docs:check
자동 main에 머지되면 docs-site 워크플로가 빌드 · 배포.
수동 · 로컬 도구 bun run docs:deploy — 워크플로 실행, 완료 대기, 배포본이 main 커밋이 될 때까지 확인. bun run docs:status는 확인만.