langchain-ai/docs

解決する問題

大規模なマルチプロジェクトエコシステムのドキュメントを書いて維持することは厄介です。このリポジトリは、ソースファイルを LangChain、LangGraph、LangSmith、および関連ツール向けの洗練されたドキュメントウェブサイト（docs.langchain.com）に変換する単一の自動化パイプラインを提供します。また、貢献者にドキュメントをローカルでプレビュー、ビルド、チェックするための一連のコマンドを提供し、公開前にエラーをキャッチできるようにします。

仕組み

コンテンツは src/ フォルダー内の Markdown ファイル（.md および .mdx）として存在します。ここが唯一編集すべき場所です。ビルドスクリプトがそれらのファイルを前処理し、デプロイ可能なバージョンを build/ フォルダーに出力します。そのフォルダーが Mintlify（ホスティングプラットフォーム）が実際に提供するものです。リポジトリには、ヘルパースクリプト、パッケージメタデータ、ナビゲーションと設定を制御する設定ファイル（docs.json）も含まれています。

日常の作業では、Make コマンドを使用します：make install は依存関係をセットアップし、make dev はライブリロード付きのローカルサーバーを起動し、make build は静的ファイルを生成し、make test はテストスイートを実行します。また、docs コマンドラインツールがあり、古い形式の Markdown や Jupyter ノートブックを Mintlify 対応形式（MkDocs や Docusaurus プロジェクトからの変換を含む）に変換し、クロスリンクを更新しながらファイルを移動できます。品質を高く保つために、リポジトリには2つのリンターが含まれています：codespell は散文のスペルミスをキャッチし、vale はルールファイルに対してスタイルをチェックします。README には、間違ったディレクトリから Mintlify を実行することによる壊れたリンクなど、一般的な Mintlify の問題のトラブルシューティング方法も説明されています。

対象読者

LangChain ドキュメントの貢献者—docs.langchain.com のページを書いたり、編集したり、修正したい人。また、ビルドプロセスを管理したり、レガシードキュメントを移行したり、リンクとスタイルの一貫性を確保する必要があるメンテナーにも役立ちます。README はコマンドラインと Git に慣れていることを前提としていますが、すべての手順を明確に説明しています。

ハイライト

• 単一の真実の源：src/ を編集し、コマンドを実行すると、Mintlify が build/ からデプロイします。
• ホットリロード付きのローカルプレビュー（make dev）。
• make broken-links-with-anchors による自動リンクチェック（アンカーを含む）。
• 既存のドキュメントを MkDocs や Docusaurus から Mintlify 形式に変換する移行ツール。
• スペルチェック（codespell）とスタイルチェック（vale）による散文の一貫性維持。
• .venv 解析エラーなど、一般的な Mintlify の落とし穴に関する明確なトラブルシューティングセクション。