コンテンツにスキップ

Knowledge Yard V2 ドキュメントポータル

このポータルは、既存のドキュメント(docs/配下)をそのまま保持しつつ、「全体像が1回で掴める」「探しやすい」ことを目的に入口を集約したものです。

まず読む(全体像)

開発・運用

データ(取り込み・スキーマ)

更新情報(公開用)

使い方(HTMLで探す)

ローカルで検索・左ナビ付きのHTML表示を使う場合は、リポジトリ直下で以下を実行します。

python -m pip install -r requirements-docs.txt
./scripts/docs-serve.sh

起動後、ブラウザで http://localhost:8000/ を開いてください。

Docs更新を依頼する

静的HTMLとして生成して開く(社内確認用)

python -m pip install -r requirements-docs.txt
./scripts/docs-build.sh

# macOS
open site/index.html