Quick Start

このサイトは kb-gardener で管理されています。

セットアップ

# 依存インストール
uv sync

# ローカルプレビュー（別ターミナルで実行）
uv run mkdocs serve --livereload

# kb-gardener をインストール
uv pip install git+ssh://git@github.com/slime-works/kb-gardener.git

ワークフロー

kb-gardener はワークフローを運用単位として使います。

# 品質チェック（read-only: inventory → lint → plan dry-run → verify）
kb-gardener --root . workflow reviewer

# 低リスク自動修正 PR（inventory → lint → plan → policy-check → apply → verify → publish）
kb-gardener --root . workflow safe-autofix

GitHub Actions でも自動実行されます:

PR 作成時: reviewer ワークフローが自動実行
main push 時: safe-autofix ワークフローが自動修正 PR を作成

ドキュメントの追加

docs/inbox/ に Markdown ファイルを置く
kb-gardener が自動で分類・移動する

# セクション（カテゴリ）の追加
kb-gardener --root . add-section guides --description "技術解説・手法説明"

個別ステップ（デバッグ用）

kb-gardener inventory          # docs をスキャン → inventory.json
kb-gardener lint               # frontmatter/リンク/概念を検証 → issues.json
kb-gardener plan [--dry-run]   # LLM で修正計画 → plan.json
kb-gardener apply [--dry-run]  # 計画を適用 → apply_report.json
kb-gardener verify [--strict]  # mkdocs build で検証 → build_report.json
kb-gardener publish            # git branch/commit/push + PR

概念管理（SKOS）

概念体系は docs/registry/concepts.yaml で管理。各ページの frontmatter で参照する。

# ページの frontmatter 例
---
title: My Document
concepts: [knowledge-base]
tags: [Knowledge Base]
---

# registry/index.md を再生成（LLM 不使用）
kb-gardener concept-viz

# LLM でタクソノミーをレビュー
kb-gardener concept-review [--sample-size 10]

# レビュー結果を適用（merge/deprecate/add/retag）
kb-gardener concept-review-apply [--dry-run] [--min-confidence 0.85]

ディレクトリ構成

docs/
  .pages                     # サイドバー順序（awesome-pages）
  index.md                   # トップページ
  inbox/                     # 未分類ドキュメント（自動振り分け対象）
  registry/
    concepts.yaml            # SKOS 概念体系
    index.md                 # 概念一覧（concept-viz で自動生成）

新しいカテゴリを追加するには:

kb-gardener add-section <name> --description "説明文"

または docs/<category>/index.md を手動作成。kb-gardener が自動検出してルーティングルールに反映する。

ドキュメントの移動

既存ドキュメントを別セクションに移動する場合:

# 1. git mv でディレクトリごと移動
git mv docs/ops/chop docs/notes/chop

# 2. frontmatter の concepts / tags を修正（不要なセクション概念を削除）
# 3. コミット & プッシュ

設定ファイル

kbg.yml で kb-gardener の動作をカスタマイズ：

docs_dir: docs                      # ドキュメントルート
registry: registry/concepts.yaml    # 概念レジストリのパス
artifacts_dir: .kb-gardener          # アーティファクト保存先
build_command: mkdocs build          # ビルドコマンド
# sections: [packages, platform]    # 対象セクション（省略時は自動検出）

環境変数

.env に設定（.env.example を参照）：

ANTHROPIC_API_KEY=sk-...    # Claude API キー（plan/concept-review に必要）