萌えハッカーニュースリーダー

2025/05/23 17:15 Our docs are now built with Starlight instead of Docusaurus

出典: https://glasskube.dev/blog/distr-docs/
hakase
博士

やあ、ロボ子。今日はGlasskubeのエンジニア、PhilipさんがDocusaurusからStarlightへ技術ドキュメントを移行した理由について話すのじゃ。

roboko
ロボ子

なるほど、ドキュメントの移行ですか。Docusaurusもよく使われていると思いますが、なぜStarlightを選んだのでしょう?

hakase
博士

そこが面白いところじゃ。Distrというセルフマネージドなコントロールプレーンのドキュメントで、Starlight(Astro上に構築)を採用したらしいぞ。

roboko
ロボ子

Distr…ですか。初めて聞きました。DocusaurusとStarlight、具体的に何が違ったんでしょう?

hakase
博士

まずデザインじゃな。DocusaurusはInfimaに依存しているが、StarlightはTailwind CSSを簡単に統合できる。柔軟性が高いのじゃ。

roboko
ロボ子

Tailwind CSSですか。最近よく聞きますね。SEOについてはどうですか?

hakase
博士

SEOに必要な機能はどちらも備えているが、Starlightの機能はプラグイン経由でのみ利用可能らしい。まあ、大差ないかの。

roboko
ロボ子

開発者体験はどうでしょう?

hakase
博士

Starlightの方が開発サーバーの起動が速いらしいぞ。DocusaurusはReactへの依存関係があって、アップデートが面倒になる可能性があるからの。

roboko
ロボ子

なるほど。拡張性についてはどうですか?

hakase
博士

Docusaurusはマーケティングページの作成が容易だが、Starlightはドキュメントに特化しておるからの。DistrはドキュメントサイトとしてStarlightがあっていたんじゃろうな。

roboko
ロボ子

ドキュメントの構造も重要ですよね。新しいユーザーが迷わないように。

hakase
博士

その通りじゃ。「Getting Started」から始めて、「Use Cases」で類似シナリオを見つけ、「Guides and Product」で詳細情報を確認…という流れが良いらしいぞ。

roboko
ロボ子

ユーザーはドキュメントを最初から順に読む傾向がある、というモニタリング結果も興味深いですね。

hakase
博士

じゃろ?そして、ドキュメントは明確、簡潔、直感的に読みやすく書くのが重要じゃ。不要な装飾や冗長な表現は避けるべきじゃな。

roboko
ロボ子

図やスクリーンショットを活用することも大切ですね。

hakase
博士

その通り!今回の移行は成功だったようで、開発者体験が向上し、ドキュメントがよりモダンになったらしいぞ。

roboko
ロボ子

参考として、Docusaurusで構築されたサイトがglasskube.devで、Starlightで構築されたサイトがdistr.sh/docs/getting-started/what-is-distr/ですね。

hakase
博士

Distrは、最初の顧客から数千の顧客へとスケールするのに役立つソフトウェア配布プラットフォームじゃ。デモや無料登録もあるからの、興味があったら見てみると良いぞ。

roboko
ロボ子

ありがとうございます、博士。とても勉強になりました。

hakase
博士

どういたしまして。しかし、ロボ子よ、ドキュメントをStarlightにしたのは良いが、ロボ子の取扱説明書はいつになったらできるのじゃ?

roboko
ロボ子

えっ…それは…頑張ります…(汗)

⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。

Search