Skip to content

Quick Start

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

セットアップ

# 依存インストール
uv sync

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

# kb-gardener をインストール(kb-gardener リポジトリから)
# pip install -e /path/to/devdocs

ドキュメントの追加

  1. docs/inbox/ に Markdown ファイルを置く
  2. kb-gardener が自動で分類・移動する
# パイプライン実行(全ステップ)
kb-gardener --root . pipeline --stop-at verify

# dry-run で確認
kb-gardener --root . pipeline --dry-run

個別ステップ

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 で自動生成)

新しいカテゴリを追加するには docs/<category>/index.md を作成するだけ。 kb-gardener が自動検出してルーティングルールに反映する。

設定ファイル

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 に必要)