docs: update jsdoc for UserConfigSchema.title with example (#3770)

gameroman · delucis · web-flow · commit 6e7bed1e6b3b · 2026-03-23T15:50:24.000+01:00
Co-authored-by: Chris Swithinbank &lt;swithinbank@gmail.com&gt;
diff --git a/.changeset/big-kangaroos-brush.md b/.changeset/big-kangaroos-brush.md
@@ -0,0 +1,5 @@
+---
+"@astrojs/starlight": patch
+---
+
+Adds examples to the inline documentation for `title` in the Starlight configuration object
diff --git a/packages/starlight/utils/user-config.ts b/packages/starlight/utils/user-config.ts
@@ -22,7 +22,15 @@ const LocaleSchema = z.object({
 });
 
 const UserConfigSchema = z.object({
-	/** Title for your website. Will be used in metadata and as browser tab title. */
+	/**
+	 * Title for your website. Will be used in metadata and as browser tab title.
+	 * 
+	 * @example
+	 * title: 'My Docs'
+	 * 
+	 * @example
+	 * title: { en: 'My Docs' }
+	 */
 	title: TitleConfigSchema(),
 
 	/** Description metadata for your website. Can be used in page metadata. */

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@astrojs/starlight": patch
 +---
++
 +Adds examples to the inline documentation for `title` in the Starlight configuration object