ドキュメントの所有境界と公開

ドキュメントの所有境界と公開

背景と目的

EAOS、Appkit、SiteKitは、実装・公開import・英語ガイド・英語JSDocをそれぞれの正本で管理します。github-docsは共通規約とプロジェクト指示雛形を管理し、承認済み公開文書を一方向に取り込みます。日本語ポータル翻訳、ナビゲーション、索引、検索、公開処理はこちらの責務です。

構成図

flowchart LR
  Sources[Project English sources and JSDoc] --> Manifest[Approved public manifests]
  Manifest --> Ingest[github-docs ingestion]
  Translations[Portal-owned Japanese translations] --> Ingest
  Policy[Shared policy and authoring skill] --> Projects[Project AGENTS references]
  Ingest --> Build[Public build and search]
  Build --> Deploy[Cloudflare Pages Git integration]

トレードオフと判断

READMEとポータルを分ける

GitHub・npm向けREADMEは通常のMarkdownで管理し、概要・価値・特徴・Quickstart・次の手順を揃えます。ポータル用のfrontmatterはREADMEから生成した別ページへ付けます。readme-policy.jsonには各プロジェクトの対象READMEを記録し、bun run docs:readmesで検証します。見出しやリンクの検証だけで、実装・例・JSDocの完全性まで保証したことにはなりません。

正本からの公開取り込み

系統	公開正本	現在のポータルID
EAOS	eaos-workspace/public/eaos	eaos-workspace
Appkit	appkit/appkit	tools
SiteKit	sitekit/sitekit	web-framework

Appkitの公開パッケージは@alneas/appkit-core・@alneas/appkit-reactです。SiteKitは@alneas/sitekit・@alneas/sitekit-cloudflareへのリネームを反映中です。公開の可否・バージョン・importは所有元manifestとリリース手順を確認してください。Private版のソース・手順・検証記録は公開取り込み対象にしません。

ポータル側の検証と公開

github-docsから次を実行します。--allは承認済み公開元だけを処理します。

bun run standards:sync
bun run standards:check
bun run ingest --all --verify
bun run ingest --all
bun run build

英語ガイドは所有元で修正します。日本語ガイドはsrc/data/translations/pages/、APIの日本語説明はsrc/data/translations/api-ja.jsonで管理し、生成結果を手で直しません。未翻訳部分は英語へフォールバックします。

承認されたmainへのpushがCloudflare PagesのGit連携を起動します。ローカルビルド・GitHubへの反映・npm公開はそれぞれ別の状態です。公開後は対象URLと内容を確認します。

関連資料

• 共通ポリシー
• 文書作成スキル
• プロジェクト指示雛形
• README検証器