docs: update jsdoc for UserConfigSchema.title with example#3770
docs: update jsdoc for UserConfigSchema.title with example#3770delucis merged 3 commits intowithastro:mainfrom
UserConfigSchema.title with example#3770Conversation
🦋 Changeset detectedLatest commit: 9d40e19 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for astro-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Hello! Thank you for opening your first PR to Starlight! ✨ Here’s what will happen next:
|
delucis
left a comment
There was a problem hiding this comment.
Thanks @gameroman! As this is a change to our core package, we should add a changeset to trigger a release. You can do that locally by running pnpm changeset add or click the link in the changeset bot comment in this PR.
Let me know if you need any guidance!
delucis
left a comment
There was a problem hiding this comment.
Perfect — thank you @gameroman 🙌
I tweaked the change description slightly to be more user-facing (e.g. UserConfigSchema is kind of an internal naming detail, so the change instead talks about “Starlight configuration” which is probably what a user might understand).
…ro#3770) Co-authored-by: Chris Swithinbank <[email protected]>
This PR contains the following updates: | Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) | |---|---|---|---| | [@astrojs/starlight](https://starlight.astro.build) ([source](https://github.com/withastro/starlight/tree/HEAD/packages/starlight)) | [`0.38.2` → `0.38.3`](https://renovatebot.com/diffs/npm/@astrojs%2fstarlight/0.38.2/0.38.3) |  |  | --- ### Release Notes <details> <summary>withastro/starlight (@​astrojs/starlight)</summary> ### [`v0.38.3`](https://github.com/withastro/starlight/blob/HEAD/packages/starlight/CHANGELOG.md#0383) [Compare Source](https://github.com/withastro/starlight/compare/@astrojs/[email protected]...@astrojs/[email protected]) ##### Patch Changes - [#​3799](withastro/starlight#3799) [`313611b`](withastro/starlight@313611b) Thanks [@​JosefJezek](https://github.com/JosefJezek)! - Improves Czech UI translations - [#​3770](withastro/starlight#3770) [`6e7bed1`](withastro/starlight@6e7bed1) Thanks [@​gameroman](https://github.com/gameroman)! - Adds examples to the inline documentation for `title` in the Starlight configuration object - [#​3801](withastro/starlight#3801) [`fedd48b`](withastro/starlight@fedd48b) Thanks [@​delucis](https://github.com/delucis)! - Fixes missing draft content warning in dev on pages using the hero layout </details> --- ### Configuration 📅 **Schedule**: (UTC) - Branch creation - At any time (no schedule defined) - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4xMDQuOCIsInVwZGF0ZWRJblZlciI6IjQzLjEwNC44IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Co-authored-by: Renovate Bot <[email protected]> Co-committed-by: Renovate Bot <[email protected]>

Description
Updated jsdoc for
UserConfigSchema.titlewith example