Mintplex-Labs/anythingllm-docs

解決する問題

このリポジトリは、AnythingLLM 製品のドキュメントをホストしています。ユーザーと開発者に、セットアップ手順、機能の説明、API リファレンス、その他のガイダンスを見つけるための構造化された場所を提供し、コードやサポートチャネルを探し回る必要をなくします。

仕組み

ドキュメントは NextJS サイトとして構築されています。pages/ フォルダには、トピック（agent、api、changelog、cloud、features、installation、setup）ごとに整理された MDX ファイルが含まれています。画像やアイコンなどの静的アセットは public/ と components/ にあります。ドキュメントをローカルで作業するには、リポジトリをクローンし、yarn を実行して依存関係をインストールし、yarn dev を実行して開発サーバーを起動します。

対象者

AnythingLLM 製品を使用または貢献するすべての人—ガイドを探しているエンドユーザー、API の詳細を確認している開発者、ドキュメント自体を改善したい貢献者。

ハイライト

• NextJS で構築（最近移行）
• コンテンツセクションが明確に分離：agent、API、changelog、cloud、features、installation、setup
• 簡単なローカル開発：クローン、yarn、yarn dev
• MIT ライセンスの下でオープンソース、プルリクエストによる明確な貢献ワークフロー