huggingface/hub-docs

解決する問題

このリポジトリは、Hugging Face Hub ウェブサイトに表示されるドキュメントの公式ソースです。ウェブサイトのコンテンツ（Markdown で記述）を、公開前に構造化された方法で保存、編集、レビューする必要性を解決します。

仕組み

サイトは docs フォルダからドキュメントコンテンツを取得します。このフォルダには Markdown ファイルが多数含まれています。変更を行うには、これらのファイルを編集し、変更をコミットして、プルリクエストを開くだけです。すると、自動化されたボットがプレビューページを構築し、マージ前に編集内容を確認できる直接 URL を提供します。簡単な編集の場合、ローカル開発環境を設定する必要はありません。ローカルでテストしたい場合は、hf-doc-builder パッケージをインストールし、doc-builder preview コマンドを使用して自分のマシンでサイトをレンダリングできます。

対象読者

Hugging Face Hub のドキュメントを読んだり、貢献したりするすべての人が対象です。これには、Hub を使用する開発者、ドキュメントを改善したいコミュニティメンバー、コンテンツの正確性を維持するテクニカルライターが含まれます。

ハイライト

• 簡単な貢献にはほとんどセットアップが不要です：Markdown ファイルを編集してプルリクエストを開くだけです。
• 自動化されたボットがすべてのプルリクエストに対してプレビュー URL を構築するため、サイトがどのように見えるかを正確に確認できます。
• 基本的な編集にはローカル環境が不要で、貢献のハードルが下がります。
• より深い作業には、公式の doc-builder ツールがローカルプレビューコマンドを提供します。
• このリポジトリは、インタラクティブな Hub ユーティリティ、推論、タスク用の関連ツールにリンクする、関連する huggingface.js パッケージを参照しています。